orb-billing 1.43.0 → 1.44.0

data/rbi/orb/models/dimensional_price_groups/price_create_params.rbi

@@ -0,0 +1,298 @@
+# typed: strong
+
+module Orb
+  module Models
+    module DimensionalPriceGroups
+      class PriceCreateParams < Orb::Internal::Type::BaseModel
+        extend Orb::Internal::Type::RequestParameters::Converter
+        include Orb::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Orb::DimensionalPriceGroups::PriceCreateParams,
+              Orb::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :dimensional_price_group_id
+
+        # Billing cadence for every price
+        sig do
+          returns(
+            Orb::DimensionalPriceGroups::PriceCreateParams::Cadence::OrSymbol
+          )
+        end
+        attr_accessor :cadence
+
+        # An ISO 4217 currency string for every price.
+        sig { returns(String) }
+        attr_accessor :currency
+
+        # The item for every price. Must be the group's billable metric item.
+        sig { returns(String) }
+        attr_accessor :item_id
+
+        sig do
+          returns(
+            Orb::DimensionalPriceGroups::PriceCreateParams::ModelType::OrSymbol
+          )
+        end
+        attr_accessor :model_type
+
+        sig do
+          returns(
+            T::Array[Orb::DimensionalPriceGroups::PriceCreateParams::Price]
+          )
+        end
+        attr_accessor :prices
+
+        # Shared tier boundaries. Required for tiered prices and omitted for unit prices.
+        sig do
+          returns(
+            T.nilable(
+              T::Array[Orb::DimensionalPriceGroups::PriceCreateParams::Tier]
+            )
+          )
+        end
+        attr_accessor :tiers
+
+        sig do
+          params(
+            dimensional_price_group_id: String,
+            cadence:
+              Orb::DimensionalPriceGroups::PriceCreateParams::Cadence::OrSymbol,
+            currency: String,
+            item_id: String,
+            model_type:
+              Orb::DimensionalPriceGroups::PriceCreateParams::ModelType::OrSymbol,
+            prices:
+              T::Array[
+                Orb::DimensionalPriceGroups::PriceCreateParams::Price::OrHash
+              ],
+            tiers:
+              T.nilable(
+                T::Array[
+                  Orb::DimensionalPriceGroups::PriceCreateParams::Tier::OrHash
+                ]
+              ),
+            request_options: Orb::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          dimensional_price_group_id:,
+          # Billing cadence for every price
+          cadence:,
+          # An ISO 4217 currency string for every price.
+          currency:,
+          # The item for every price. Must be the group's billable metric item.
+          item_id:,
+          model_type:,
+          prices:,
+          # Shared tier boundaries. Required for tiered prices and omitted for unit prices.
+          tiers: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              dimensional_price_group_id: String,
+              cadence:
+                Orb::DimensionalPriceGroups::PriceCreateParams::Cadence::OrSymbol,
+              currency: String,
+              item_id: String,
+              model_type:
+                Orb::DimensionalPriceGroups::PriceCreateParams::ModelType::OrSymbol,
+              prices:
+                T::Array[Orb::DimensionalPriceGroups::PriceCreateParams::Price],
+              tiers:
+                T.nilable(
+                  T::Array[Orb::DimensionalPriceGroups::PriceCreateParams::Tier]
+                ),
+              request_options: Orb::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Billing cadence for every price
+        module Cadence
+          extend Orb::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Orb::DimensionalPriceGroups::PriceCreateParams::Cadence
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          ONE_TIME =
+            T.let(
+              :one_time,
+              Orb::DimensionalPriceGroups::PriceCreateParams::Cadence::TaggedSymbol
+            )
+          MONTHLY =
+            T.let(
+              :monthly,
+              Orb::DimensionalPriceGroups::PriceCreateParams::Cadence::TaggedSymbol
+            )
+          QUARTERLY =
+            T.let(
+              :quarterly,
+              Orb::DimensionalPriceGroups::PriceCreateParams::Cadence::TaggedSymbol
+            )
+          SEMI_ANNUAL =
+            T.let(
+              :semi_annual,
+              Orb::DimensionalPriceGroups::PriceCreateParams::Cadence::TaggedSymbol
+            )
+          ANNUAL =
+            T.let(
+              :annual,
+              Orb::DimensionalPriceGroups::PriceCreateParams::Cadence::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Orb::DimensionalPriceGroups::PriceCreateParams::Cadence::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        module ModelType
+          extend Orb::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Orb::DimensionalPriceGroups::PriceCreateParams::ModelType
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          UNIT =
+            T.let(
+              :unit,
+              Orb::DimensionalPriceGroups::PriceCreateParams::ModelType::TaggedSymbol
+            )
+          TIERED =
+            T.let(
+              :tiered,
+              Orb::DimensionalPriceGroups::PriceCreateParams::ModelType::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Orb::DimensionalPriceGroups::PriceCreateParams::ModelType::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        class Price < Orb::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Orb::DimensionalPriceGroups::PriceCreateParams::Price,
+                Orb::Internal::AnyHash
+              )
+            end
+
+          # One amount for a unit price. One amount per tier for a tiered price, in tier
+          # order.
+          sig { returns(T::Array[Float]) }
+          attr_accessor :amounts
+
+          # Dimension values, in the group's dimension order.
+          sig { returns(T::Array[String]) }
+          attr_accessor :dimension_values
+
+          # Price name. Defaults to the dimension values.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :name
+
+          sig do
+            params(
+              amounts: T::Array[Float],
+              dimension_values: T::Array[String],
+              name: T.nilable(String)
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # One amount for a unit price. One amount per tier for a tiered price, in tier
+            # order.
+            amounts:,
+            # Dimension values, in the group's dimension order.
+            dimension_values:,
+            # Price name. Defaults to the dimension values.
+            name: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                amounts: T::Array[Float],
+                dimension_values: T::Array[String],
+                name: T.nilable(String)
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+
+        class Tier < Orb::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Orb::DimensionalPriceGroups::PriceCreateParams::Tier,
+                Orb::Internal::AnyHash
+              )
+            end
+
+          # Exclusive tier starting value
+          sig { returns(Float) }
+          attr_accessor :first_unit
+
+          # Inclusive tier ending value. Null on the last tier.
+          sig { returns(T.nilable(Float)) }
+          attr_accessor :last_unit
+
+          sig do
+            params(first_unit: Float, last_unit: T.nilable(Float)).returns(
+              T.attached_class
+            )
+          end
+          def self.new(
+            # Exclusive tier starting value
+            first_unit:,
+            # Inclusive tier ending value. Null on the last tier.
+            last_unit: nil
+          )
+          end
+
+          sig do
+            override.returns({ first_unit: Float, last_unit: T.nilable(Float) })
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/orb/models/dimensional_price_groups/price_create_response.rbi

@@ -0,0 +1,76 @@
+# typed: strong
+
+module Orb
+  module Models
+    module DimensionalPriceGroups
+      class PriceCreateResponse < Orb::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Orb::Models::DimensionalPriceGroups::PriceCreateResponse,
+              Orb::Internal::AnyHash
+            )
+          end
+
+        # The prices created by this request, in request order.
+        sig { returns(T::Array[Orb::Price::Variants]) }
+        attr_accessor :data
+
+        sig do
+          params(
+            data:
+              T::Array[
+                T.any(
+                  Orb::Price::Unit::OrHash,
+                  Orb::Price::Tiered::OrHash,
+                  Orb::Price::Bulk::OrHash,
+                  Orb::Price::BulkWithFilters::OrHash,
+                  Orb::Price::Package::OrHash,
+                  Orb::Price::Matrix::OrHash,
+                  Orb::Price::ThresholdTotalAmount::OrHash,
+                  Orb::Price::TieredPackage::OrHash,
+                  Orb::Price::TieredWithMinimum::OrHash,
+                  Orb::Price::GroupedTiered::OrHash,
+                  Orb::Price::GroupedTieredMatrix::OrHash,
+                  Orb::Price::TieredPackageWithMinimum::OrHash,
+                  Orb::Price::PackageWithAllocation::OrHash,
+                  Orb::Price::UnitWithPercent::OrHash,
+                  Orb::Price::MatrixWithAllocation::OrHash,
+                  Orb::Price::TieredMatrixWithAllocation::OrHash,
+                  Orb::Price::MatrixWithThresholdDiscounts::OrHash,
+                  Orb::Price::TieredWithProration::OrHash,
+                  Orb::Price::UnitWithProration::OrHash,
+                  Orb::Price::GroupedAllocation::OrHash,
+                  Orb::Price::BulkWithProration::OrHash,
+                  Orb::Price::GroupedWithProratedMinimum::OrHash,
+                  Orb::Price::GroupedWithMeteredMinimum::OrHash,
+                  Orb::Price::GroupedWithMinMaxThresholds::OrHash,
+                  Orb::Price::MatrixWithDisplayName::OrHash,
+                  Orb::Price::GroupedTieredPackage::OrHash,
+                  Orb::Price::MaxGroupTieredPackage::OrHash,
+                  Orb::Price::ScalableMatrixWithUnitPricing::OrHash,
+                  Orb::Price::ScalableMatrixWithTieredPricing::OrHash,
+                  Orb::Price::CumulativeGroupedBulk::OrHash,
+                  Orb::Price::CumulativeGroupedAllocation::OrHash,
+                  Orb::Price::DailyCreditAllowance::OrHash,
+                  Orb::Price::MeteredAllowance::OrHash,
+                  Orb::Price::MinimumComposite::OrHash,
+                  Orb::Price::Percent::OrHash,
+                  Orb::Price::EventOutput::OrHash
+                )
+              ]
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The prices created by this request, in request order.
+          data:
+        )
+        end
+
+        sig { override.returns({ data: T::Array[Orb::Price::Variants] }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/orb/models/dimensional_price_groups/price_list_params.rbi

@@ -0,0 +1,134 @@
+# typed: strong
+
+module Orb
+  module Models
+    module DimensionalPriceGroups
+      class PriceListParams < Orb::Internal::Type::BaseModel
+        extend Orb::Internal::Type::RequestParameters::Converter
+        include Orb::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Orb::DimensionalPriceGroups::PriceListParams,
+              Orb::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :dimensional_price_group_id
+
+        # Cursor for pagination. This can be populated by the `next_cursor` value returned
+        # from the initial request.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :cursor
+
+        # The number of items to fetch. Defaults to 20.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :limit
+
+        sig { params(limit: Integer).void }
+        attr_writer :limit
+
+        # active omits archived prices. archived returns only archived prices. all returns
+        # both.
+        sig do
+          returns(
+            T.nilable(
+              Orb::DimensionalPriceGroups::PriceListParams::Status::OrSymbol
+            )
+          )
+        end
+        attr_reader :status
+
+        sig do
+          params(
+            status:
+              Orb::DimensionalPriceGroups::PriceListParams::Status::OrSymbol
+          ).void
+        end
+        attr_writer :status
+
+        sig do
+          params(
+            dimensional_price_group_id: String,
+            cursor: T.nilable(String),
+            limit: Integer,
+            status:
+              Orb::DimensionalPriceGroups::PriceListParams::Status::OrSymbol,
+            request_options: Orb::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          dimensional_price_group_id:,
+          # Cursor for pagination. This can be populated by the `next_cursor` value returned
+          # from the initial request.
+          cursor: nil,
+          # The number of items to fetch. Defaults to 20.
+          limit: nil,
+          # active omits archived prices. archived returns only archived prices. all returns
+          # both.
+          status: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              dimensional_price_group_id: String,
+              cursor: T.nilable(String),
+              limit: Integer,
+              status:
+                Orb::DimensionalPriceGroups::PriceListParams::Status::OrSymbol,
+              request_options: Orb::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # active omits archived prices. archived returns only archived prices. all returns
+        # both.
+        module Status
+          extend Orb::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Orb::DimensionalPriceGroups::PriceListParams::Status
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          ACTIVE =
+            T.let(
+              :active,
+              Orb::DimensionalPriceGroups::PriceListParams::Status::TaggedSymbol
+            )
+          ARCHIVED =
+            T.let(
+              :archived,
+              Orb::DimensionalPriceGroups::PriceListParams::Status::TaggedSymbol
+            )
+          ALL =
+            T.let(
+              :all,
+              Orb::DimensionalPriceGroups::PriceListParams::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Orb::DimensionalPriceGroups::PriceListParams::Status::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/orb/models/plan_created_webhook_event.rbi

@@ -0,0 +1,140 @@
+# typed: strong
+
+module Orb
+  module Models
+    class PlanCreatedWebhookEvent < Orb::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Orb::PlanCreatedWebhookEvent, Orb::Internal::AnyHash)
+        end
+
+      # The ID of this webhook event.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The time at which this event was created, to the second.
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      sig { returns(Orb::PlanCreatedWebhookEvent::Plan) }
+      attr_reader :plan
+
+      sig { params(plan: Orb::PlanCreatedWebhookEvent::Plan::OrHash).void }
+      attr_writer :plan
+
+      sig { returns(T.anything) }
+      attr_accessor :properties
+
+      # The event this payload describes.
+      sig { returns(Orb::PlanCreatedWebhookEvent::Type::TaggedSymbol) }
+      attr_accessor :type
+
+      # Issued when a plan is created, or when a draft plan is published.
+      sig do
+        params(
+          id: String,
+          created_at: Time,
+          plan: Orb::PlanCreatedWebhookEvent::Plan::OrHash,
+          properties: T.anything,
+          type: Orb::PlanCreatedWebhookEvent::Type::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The ID of this webhook event.
+        id:,
+        # The time at which this event was created, to the second.
+        created_at:,
+        plan:,
+        properties:,
+        # The event this payload describes.
+        type:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            created_at: Time,
+            plan: Orb::PlanCreatedWebhookEvent::Plan,
+            properties: T.anything,
+            type: Orb::PlanCreatedWebhookEvent::Type::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Plan < Orb::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Orb::PlanCreatedWebhookEvent::Plan, Orb::Internal::AnyHash)
+          end
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :id
+
+        # An optional user-defined ID for this plan resource, used throughout the system
+        # as an alias for this Plan. Use this field to identify a plan by an existing
+        # identifier in your system.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :external_plan_id
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :name
+
+        sig do
+          params(
+            id: T.nilable(String),
+            external_plan_id: T.nilable(String),
+            name: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          id:,
+          # An optional user-defined ID for this plan resource, used throughout the system
+          # as an alias for this Plan. Use this field to identify a plan by an existing
+          # identifier in your system.
+          external_plan_id:,
+          name:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: T.nilable(String),
+              external_plan_id: T.nilable(String),
+              name: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+
+      # The event this payload describes.
+      module Type
+        extend Orb::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Orb::PlanCreatedWebhookEvent::Type) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        PLAN_CREATED =
+          T.let(
+            :"plan.created",
+            Orb::PlanCreatedWebhookEvent::Type::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Orb::PlanCreatedWebhookEvent::Type::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end