orb-billing 0.3.1 → 0.4.0

data/lib/orb/models/customers/credits/top_up_list_params.rb

@@ -27,7 +27,6 @@ module Orb
           #   {Orb::Models::Customers::Credits::TopUpListParams} 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.
           #

data/lib/orb/models/customers/credits/top_up_list_response.rb

@@ -67,17 +67,14 @@ module Orb
           #   @param amount [String] The amount to increment when the threshold is reached.
           #
           #   @param currency [String] The currency or custom pricing unit to use for this top-up. If this is a real-wo
-          #   ...
           #
           #   @param invoice_settings [Orb::Models::Customers::Credits::TopUpListResponse::InvoiceSettings] Settings for invoices generated by triggered top-ups.
           #
           #   @param per_unit_cost_basis [String] How much, in the customer's currency, to charge for each unit.
           #
           #   @param threshold [String] The threshold at which to trigger the top-up. If the balance is at or below this
-          #   ...
           #
           #   @param expires_after [Integer, nil] The number of days or months after which the top-up expires. If unspecified, it
-          #   ...
           #
           #   @param expires_after_unit [Symbol, Orb::Models::Customers::Credits::TopUpListResponse::ExpiresAfterUnit, nil] The unit of expires_after.
 
@@ -119,15 +116,12 @@ module Orb
             #   Settings for invoices generated by triggered top-ups.
             #
             #   @param auto_collection [Boolean] Whether the credits purchase invoice should auto collect with the customer's sav
-            #   ...
             #
             #   @param net_terms [Integer] The net terms determines the difference between the invoice date and the issue d
-            #   ...
             #
             #   @param memo [String, nil] An optional memo to display on the invoice.
             #
             #   @param require_successful_payment [Boolean] If true, new credit blocks created by this top-up will require that the correspo
-            #   ...
           end
 
           # The unit of expires_after.

data/lib/orb/models/dimensional_price_group.rb

@@ -46,7 +46,7 @@ module Orb
 
       # @!method initialize(id:, billable_metric_id:, dimensions:, external_dimensional_price_group_id:, metadata:, name:)
       #   Some parameter documentations has been truncated, see
-      #   {Orb::Models::DimensionalPriceGroup} for more details.
+      #   {Orb::DimensionalPriceGroup} for more details.
       #
       #   A dimensional price group is used to partition the result of a billable metric
       #   by a set of dimensions. Prices in a price group must specify the parition used
@@ -55,14 +55,12 @@ module Orb
       #   @param id [String]
       #
       #   @param billable_metric_id [String] The billable metric associated with this dimensional price group. All prices ass
-      #   ...
       #
       #   @param dimensions [Array<String>] The dimensions that this dimensional price group is defined over
       #
       #   @param external_dimensional_price_group_id [String, nil] An alias for the dimensional price group
       #
       #   @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
-      #   ...
       #
       #   @param name [String] The name of the dimensional price group
     end

data/lib/orb/models/dimensional_price_group_create_params.rb

@@ -49,7 +49,6 @@ module Orb
       #   @param external_dimensional_price_group_id [String, nil]
       #
       #   @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
-      #   ...
       #
       #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
     end

data/lib/orb/models/dimensional_price_group_list_params.rb

@@ -25,7 +25,6 @@ module Orb
       #   {Orb::Models::DimensionalPriceGroupListParams} 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.
       #

data/lib/orb/models/dimensional_price_groups.rb

@@ -5,17 +5,17 @@ module Orb
     class DimensionalPriceGroupsAPI < Orb::Internal::Type::BaseModel
       # @!attribute data
       #
-      #   @return [Array<Orb::Models::DimensionalPriceGroup>]
-      required :data, -> { Orb::Internal::Type::ArrayOf[Orb::Models::DimensionalPriceGroup] }
+      #   @return [Array<Orb::DimensionalPriceGroup>]
+      required :data, -> { Orb::Internal::Type::ArrayOf[Orb::DimensionalPriceGroup] }
 
       # @!attribute pagination_metadata
       #
-      #   @return [Orb::Models::PaginationMetadata]
-      required :pagination_metadata, -> { Orb::Models::PaginationMetadata }
+      #   @return [Orb::PaginationMetadata]
+      required :pagination_metadata, -> { Orb::PaginationMetadata }
 
       # @!method initialize(data:, pagination_metadata:)
-      #   @param data [Array<Orb::Models::DimensionalPriceGroup>]
-      #   @param pagination_metadata [Orb::Models::PaginationMetadata]
+      #   @param data [Array<Orb::DimensionalPriceGroup>]
+      #   @param pagination_metadata [Orb::PaginationMetadata]
     end
   end
 end

data/lib/orb/models/discount.rb

@@ -7,16 +7,22 @@ module Orb
 
       discriminator :discount_type
 
-      variant :percentage, -> { Orb::Models::PercentageDiscount }
+      variant :percentage, -> { Orb::PercentageDiscount }
 
-      variant :trial, -> { Orb::Models::TrialDiscount }
+      variant :trial, -> { Orb::TrialDiscount }
 
-      variant :usage, -> { Orb::Models::UsageDiscount }
+      variant :usage, -> { Orb::UsageDiscount }
 
-      variant :amount, -> { Orb::Models::AmountDiscount }
+      variant :amount, -> { Orb::AmountDiscount }
 
       # @!method self.variants
-      #   @return [Array(Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount)]
+      #   @return [Array(Orb::PercentageDiscount, Orb::TrialDiscount, Orb::UsageDiscount, Orb::AmountDiscount)]
+
+      define_sorbet_constant!(:Variants) do
+        T.type_alias do
+          T.any(Orb::PercentageDiscount, Orb::TrialDiscount, Orb::UsageDiscount, Orb::AmountDiscount)
+        end
+      end
     end
   end
 end

data/lib/orb/models/evaluate_price_group.rb

@@ -14,7 +14,7 @@ module Orb
       #
       #   @return [Array<String, Float, Boolean>]
       required :grouping_values,
-               -> { Orb::Internal::Type::ArrayOf[union: Orb::Models::EvaluatePriceGroup::GroupingValue] }
+               -> { Orb::Internal::Type::ArrayOf[union: Orb::EvaluatePriceGroup::GroupingValue] }
 
       # @!attribute quantity
       #   The price's usage quantity for the group
@@ -40,6 +40,10 @@ module Orb
 
         # @!method self.variants
         #   @return [Array(String, Float, Boolean)]
+
+        define_sorbet_constant!(:Variants) do
+          T.type_alias { T.any(String, Float, T::Boolean) }
+        end
       end
     end
   end

data/lib/orb/models/event_ingest_params.rb

@@ -9,8 +9,8 @@ module Orb
 
       # @!attribute events
       #
-      #   @return [Array<Orb::Models::EventIngestParams::Event>]
-      required :events, -> { Orb::Internal::Type::ArrayOf[Orb::Models::EventIngestParams::Event] }
+      #   @return [Array<Orb::EventIngestParams::Event>]
+      required :events, -> { Orb::Internal::Type::ArrayOf[Orb::EventIngestParams::Event] }
 
       # @!attribute backfill_id
       #   If this ingestion request is part of a backfill, this parameter ties the
@@ -29,10 +29,9 @@ module Orb
       #   Some parameter documentations has been truncated, see
       #   {Orb::Models::EventIngestParams} for more details.
       #
-      #   @param events [Array<Orb::Models::EventIngestParams::Event>]
+      #   @param events [Array<Orb::EventIngestParams::Event>]
       #
       #   @param backfill_id [String, nil] If this ingestion request is part of a backfill, this parameter ties the ingeste
-      #   ...
       #
       #   @param debug [Boolean] Flag to enable additional debug information in the endpoint response
       #
@@ -83,23 +82,19 @@ module Orb
 
         # @!method initialize(event_name:, idempotency_key:, properties:, timestamp:, customer_id: nil, external_customer_id: nil)
         #   Some parameter documentations has been truncated, see
-        #   {Orb::Models::EventIngestParams::Event} for more details.
+        #   {Orb::EventIngestParams::Event} for more details.
         #
         #   @param event_name [String] A name to meaningfully identify the action or event type.
         #
         #   @param idempotency_key [String] A unique value, generated by the client, that is used to de-duplicate events. Ex
-        #   ...
         #
         #   @param properties [Object] A dictionary of custom properties. Values in this dictionary must be numeric, bo
-        #   ...
         #
         #   @param timestamp [Time] An ISO 8601 format date with no timezone offset (i.e. UTC). This should represen
-        #   ...
         #
         #   @param customer_id [String, nil] The Orb Customer identifier
         #
         #   @param external_customer_id [String, nil] An alias for the Orb customer, whose mapping is specified when creating the cust
-        #   ...
       end
     end
   end

data/lib/orb/models/event_ingest_response.rb

@@ -24,10 +24,8 @@ module Orb
       #   {Orb::Models::EventIngestResponse} for more details.
       #
       #   @param validation_failed [Array<Orb::Models::EventIngestResponse::ValidationFailed>] Contains all failing validation events. In the case of a 200, this array will al
-      #   ...
       #
       #   @param debug [Orb::Models::EventIngestResponse::Debug, nil] Optional debug information (only present when debug=true is passed to the endpoi
-      #   ...
 
       class ValidationFailed < Orb::Internal::Type::BaseModel
         # @!attribute idempotency_key
@@ -50,7 +48,6 @@ module Orb
         #   @param idempotency_key [String] The passed idempotency_key corresponding to the validation_errors
         #
         #   @param validation_errors [Array<String>] An array of strings corresponding to validation failures for this idempotency_ke
-        #   ...
       end
 
       # @see Orb::Models::EventIngestResponse#debug

data/lib/orb/models/event_search_params.rb

@@ -35,13 +35,10 @@ module Orb
       #   {Orb::Models::EventSearchParams} for more details.
       #
       #   @param event_ids [Array<String>] This is an explicit array of IDs to filter by. Note that an event's ID is the id
-      #   ...
       #
       #   @param timeframe_end [Time, nil] The end of the timeframe, exclusive, in which to search events. If not specified
-      #   ...
       #
       #   @param timeframe_start [Time, nil] The start of the timeframe, inclusive, in which to search events. If not specifi
-      #   ...
       #
       #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
     end

data/lib/orb/models/event_search_response.rb

@@ -70,7 +70,6 @@ module Orb
         #   model, and are used to calculate the usage charges for a given billing period.
         #
         #   @param id [String] A unique value, generated by the client, that is used to de-duplicate events. Ex
-        #   ...
         #
         #   @param customer_id [String, nil] The Orb Customer identifier
         #
@@ -79,13 +78,10 @@ module Orb
         #   @param event_name [String] A name to meaningfully identify the action or event type.
         #
         #   @param external_customer_id [String, nil] An alias for the Orb customer, whose mapping is specified when creating the cust
-        #   ...
         #
         #   @param properties [Object] A dictionary of custom properties. Values in this dictionary must be numeric, bo
-        #   ...
         #
         #   @param timestamp [Time] An ISO 8601 format date with no timezone offset (i.e. UTC). This should represen
-        #   ...
       end
     end
   end

data/lib/orb/models/event_update_params.rb

@@ -48,15 +48,12 @@ module Orb
       #   @param event_name [String] A name to meaningfully identify the action or event type.
       #
       #   @param properties [Object] A dictionary of custom properties. Values in this dictionary must be numeric, bo
-      #   ...
       #
       #   @param timestamp [Time] An ISO 8601 format date with no timezone offset (i.e. UTC). This should represen
-      #   ...
       #
       #   @param customer_id [String, nil] The Orb Customer identifier
       #
       #   @param external_customer_id [String, nil] An alias for the Orb customer, whose mapping is specified when creating the cust
-      #   ...
       #
       #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
     end

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

@@ -83,17 +83,14 @@ module Orb
         #   @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.
         #
@@ -104,7 +101,6 @@ module Orb
         #   @param timeframe_start [Time]
         #
         #   @param deprecation_filter [String, nil] A boolean [computed property](/extensibility/advanced-metrics#computed-propertie
-        #   ...
 
         # The status of the backfill.
         #

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

@@ -66,25 +66,18 @@ module Orb
         #   {Orb::Models::Events::BackfillCreateParams} for more details.
         #
         #   @param timeframe_end [Time] The (exclusive) end of the usage timeframe affected by this backfill. By default
-        #   ...
         #
         #   @param timeframe_start [Time] The (inclusive) start of the usage timeframe affected by this backfill. By defau
-        #   ...
         #
         #   @param close_time [Time, nil] The time at which no more events will be accepted for this backfill. The backfil
-        #   ...
         #
         #   @param customer_id [String, nil] The Orb-generated ID of the customer to which this backfill is scoped. Omitting
-        #   ...
         #
         #   @param deprecation_filter [String, nil] A boolean [computed property](/extensibility/advanced-metrics#computed-propertie
-        #   ...
         #
         #   @param external_customer_id [String, nil] The external customer ID of the customer to which this backfill is scoped. Omitt
-        #   ...
         #
         #   @param replace_existing_events [Boolean] If true, replaces all existing events in the timeframe with the newly ingested e
-        #   ...
         #
         #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
       end

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

@@ -83,17 +83,14 @@ module Orb
         #   @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.
         #
@@ -104,7 +101,6 @@ module Orb
         #   @param timeframe_start [Time]
         #
         #   @param deprecation_filter [String, nil] A boolean [computed property](/extensibility/advanced-metrics#computed-propertie
-        #   ...
 
         # The status of the backfill.
         #

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

@@ -83,17 +83,14 @@ module Orb
         #   @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.
         #
@@ -104,7 +101,6 @@ module Orb
         #   @param timeframe_start [Time]
         #
         #   @param deprecation_filter [String, nil] A boolean [computed property](/extensibility/advanced-metrics#computed-propertie
-        #   ...
 
         # The status of the backfill.
         #

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

@@ -26,7 +26,6 @@ module Orb
         #   {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.
         #

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

@@ -83,17 +83,14 @@ module Orb
         #   @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.
         #
@@ -104,7 +101,6 @@ module Orb
         #   @param timeframe_start [Time]
         #
         #   @param deprecation_filter [String, nil] A boolean [computed property](/extensibility/advanced-metrics#computed-propertie
-        #   ...
 
         # The status of the backfill.
         #

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

@@ -83,17 +83,14 @@ module Orb
         #   @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.
         #
@@ -104,7 +101,6 @@ module Orb
         #   @param timeframe_start [Time]
         #
         #   @param deprecation_filter [String, nil] A boolean [computed property](/extensibility/advanced-metrics#computed-propertie
-        #   ...
 
         # The status of the backfill.
         #

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

@@ -7,11 +7,11 @@ module Orb
       class EventVolumes < Orb::Internal::Type::BaseModel
         # @!attribute data
         #
-        #   @return [Array<Orb::Models::Events::EventVolumes::Data>]
-        required :data, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Events::EventVolumes::Data] }
+        #   @return [Array<Orb::Events::EventVolumes::Data>]
+        required :data, -> { Orb::Internal::Type::ArrayOf[Orb::Events::EventVolumes::Data] }
 
         # @!method initialize(data:)
-        #   @param data [Array<Orb::Models::Events::EventVolumes::Data>]
+        #   @param data [Array<Orb::Events::EventVolumes::Data>]
 
         class Data < Orb::Internal::Type::BaseModel
           # @!attribute count

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

@@ -44,15 +44,12 @@ module Orb
         #   {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