orb-billing 0.3.1 → 0.3.2

data/rbi/orb/models/trial_discount.rbi

@@ -3,12 +3,14 @@
 module Orb
   module Models
     class TrialDiscount < Orb::Internal::Type::BaseModel
+      OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
+
       # List of price_ids that this discount applies to. For plan/plan phase discounts,
       # this can be a subset of prices.
       sig { returns(T::Array[String]) }
       attr_accessor :applies_to_price_ids
 
-      sig { returns(Orb::Models::TrialDiscount::DiscountType::OrSymbol) }
+      sig { returns(Orb::TrialDiscount::DiscountType::OrSymbol) }
       attr_accessor :discount_type
 
       sig { returns(T.nilable(String)) }
@@ -25,12 +27,11 @@ module Orb
       sig do
         params(
           applies_to_price_ids: T::Array[String],
-          discount_type: Orb::Models::TrialDiscount::DiscountType::OrSymbol,
+          discount_type: Orb::TrialDiscount::DiscountType::OrSymbol,
           reason: T.nilable(String),
           trial_amount_discount: T.nilable(String),
           trial_percentage_discount: T.nilable(Float)
-        )
-          .returns(T.attached_class)
+        ).returns(T.attached_class)
       end
       def self.new(
         # List of price_ids that this discount applies to. For plan/plan phase discounts,
@@ -42,31 +43,39 @@ module Orb
         trial_amount_discount: nil,
         # Only available if discount_type is `trial`
         trial_percentage_discount: nil
-      ); end
+      )
+      end
+
       sig do
-        override
-          .returns(
-            {
-              applies_to_price_ids: T::Array[String],
-              discount_type: Orb::Models::TrialDiscount::DiscountType::OrSymbol,
-              reason: T.nilable(String),
-              trial_amount_discount: T.nilable(String),
-              trial_percentage_discount: T.nilable(Float)
-            }
-          )
+        override.returns(
+          {
+            applies_to_price_ids: T::Array[String],
+            discount_type: Orb::TrialDiscount::DiscountType::OrSymbol,
+            reason: T.nilable(String),
+            trial_amount_discount: T.nilable(String),
+            trial_percentage_discount: T.nilable(Float)
+          }
+        )
+      end
+      def to_hash
       end
-      def to_hash; end
 
       module DiscountType
         extend Orb::Internal::Type::Enum
 
-        TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::TrialDiscount::DiscountType) }
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Orb::TrialDiscount::DiscountType) }
         OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-        TRIAL = T.let(:trial, Orb::Models::TrialDiscount::DiscountType::TaggedSymbol)
+        TRIAL = T.let(:trial, Orb::TrialDiscount::DiscountType::TaggedSymbol)
 
-        sig { override.returns(T::Array[Orb::Models::TrialDiscount::DiscountType::TaggedSymbol]) }
-        def self.values; end
+        sig do
+          override.returns(
+            T::Array[Orb::TrialDiscount::DiscountType::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
       end
     end
   end

data/rbi/orb/models/usage_discount.rbi

@@ -3,12 +3,14 @@
 module Orb
   module Models
     class UsageDiscount < Orb::Internal::Type::BaseModel
+      OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
+
       # List of price_ids that this discount applies to. For plan/plan phase discounts,
       # this can be a subset of prices.
       sig { returns(T::Array[String]) }
       attr_accessor :applies_to_price_ids
 
-      sig { returns(Orb::Models::UsageDiscount::DiscountType::OrSymbol) }
+      sig { returns(Orb::UsageDiscount::DiscountType::OrSymbol) }
       attr_accessor :discount_type
 
       # Only available if discount_type is `usage`. Number of usage units that this
@@ -22,11 +24,10 @@ module Orb
       sig do
         params(
           applies_to_price_ids: T::Array[String],
-          discount_type: Orb::Models::UsageDiscount::DiscountType::OrSymbol,
+          discount_type: Orb::UsageDiscount::DiscountType::OrSymbol,
           usage_discount: Float,
           reason: T.nilable(String)
-        )
-          .returns(T.attached_class)
+        ).returns(T.attached_class)
       end
       def self.new(
         # List of price_ids that this discount applies to. For plan/plan phase discounts,
@@ -37,30 +38,38 @@ module Orb
         # discount is for
         usage_discount:,
         reason: nil
-      ); end
+      )
+      end
+
       sig do
-        override
-          .returns(
-            {
-              applies_to_price_ids: T::Array[String],
-              discount_type: Orb::Models::UsageDiscount::DiscountType::OrSymbol,
-              usage_discount: Float,
-              reason: T.nilable(String)
-            }
-          )
+        override.returns(
+          {
+            applies_to_price_ids: T::Array[String],
+            discount_type: Orb::UsageDiscount::DiscountType::OrSymbol,
+            usage_discount: Float,
+            reason: T.nilable(String)
+          }
+        )
+      end
+      def to_hash
       end
-      def to_hash; end
 
       module DiscountType
         extend Orb::Internal::Type::Enum
 
-        TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::UsageDiscount::DiscountType) }
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Orb::UsageDiscount::DiscountType) }
         OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-        USAGE = T.let(:usage, Orb::Models::UsageDiscount::DiscountType::TaggedSymbol)
+        USAGE = T.let(:usage, Orb::UsageDiscount::DiscountType::TaggedSymbol)
 
-        sig { override.returns(T::Array[Orb::Models::UsageDiscount::DiscountType::TaggedSymbol]) }
-        def self.values; end
+        sig do
+          override.returns(
+            T::Array[Orb::UsageDiscount::DiscountType::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
       end
     end
   end

data/rbi/orb/models.rbi

@@ -5,9 +5,11 @@ module Orb
 
   AlertCreateForCustomerParams = Orb::Models::AlertCreateForCustomerParams
 
-  AlertCreateForExternalCustomerParams = Orb::Models::AlertCreateForExternalCustomerParams
+  AlertCreateForExternalCustomerParams =
+    Orb::Models::AlertCreateForExternalCustomerParams
 
-  AlertCreateForSubscriptionParams = Orb::Models::AlertCreateForSubscriptionParams
+  AlertCreateForSubscriptionParams =
+    Orb::Models::AlertCreateForSubscriptionParams
 
   AlertDisableParams = Orb::Models::AlertDisableParams
 
@@ -62,19 +64,23 @@ module Orb
   CustomerSyncPaymentMethodsFromGatewayByExternalCustomerIDParams =
     Orb::Models::CustomerSyncPaymentMethodsFromGatewayByExternalCustomerIDParams
 
-  CustomerSyncPaymentMethodsFromGatewayParams = Orb::Models::CustomerSyncPaymentMethodsFromGatewayParams
+  CustomerSyncPaymentMethodsFromGatewayParams =
+    Orb::Models::CustomerSyncPaymentMethodsFromGatewayParams
 
-  CustomerUpdateByExternalIDParams = Orb::Models::CustomerUpdateByExternalIDParams
+  CustomerUpdateByExternalIDParams =
+    Orb::Models::CustomerUpdateByExternalIDParams
 
   CustomerUpdateParams = Orb::Models::CustomerUpdateParams
 
   DimensionalPriceGroup = Orb::Models::DimensionalPriceGroup
 
-  DimensionalPriceGroupCreateParams = Orb::Models::DimensionalPriceGroupCreateParams
+  DimensionalPriceGroupCreateParams =
+    Orb::Models::DimensionalPriceGroupCreateParams
 
   DimensionalPriceGroupListParams = Orb::Models::DimensionalPriceGroupListParams
 
-  DimensionalPriceGroupRetrieveParams = Orb::Models::DimensionalPriceGroupRetrieveParams
+  DimensionalPriceGroupRetrieveParams =
+    Orb::Models::DimensionalPriceGroupRetrieveParams
 
   DimensionalPriceGroups = Orb::Models::DimensionalPriceGroups
 
@@ -174,7 +180,8 @@ module Orb
 
   SubscriptionChangeCancelParams = Orb::Models::SubscriptionChangeCancelParams
 
-  SubscriptionChangeRetrieveParams = Orb::Models::SubscriptionChangeRetrieveParams
+  SubscriptionChangeRetrieveParams =
+    Orb::Models::SubscriptionChangeRetrieveParams
 
   SubscriptionCreateParams = Orb::Models::SubscriptionCreateParams
 
@@ -188,15 +195,18 @@ module Orb
 
   SubscriptionListParams = Orb::Models::SubscriptionListParams
 
-  SubscriptionPriceIntervalsParams = Orb::Models::SubscriptionPriceIntervalsParams
+  SubscriptionPriceIntervalsParams =
+    Orb::Models::SubscriptionPriceIntervalsParams
 
   SubscriptionsAPI = Orb::Models::SubscriptionsAPI
 
-  SubscriptionSchedulePlanChangeParams = Orb::Models::SubscriptionSchedulePlanChangeParams
+  SubscriptionSchedulePlanChangeParams =
+    Orb::Models::SubscriptionSchedulePlanChangeParams
 
   SubscriptionTriggerPhaseParams = Orb::Models::SubscriptionTriggerPhaseParams
 
-  SubscriptionUnscheduleCancellationParams = Orb::Models::SubscriptionUnscheduleCancellationParams
+  SubscriptionUnscheduleCancellationParams =
+    Orb::Models::SubscriptionUnscheduleCancellationParams
 
   SubscriptionUnscheduleFixedFeeQuantityUpdatesParams =
     Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesParams
@@ -204,7 +214,8 @@ module Orb
   SubscriptionUnschedulePendingPlanChangesParams =
     Orb::Models::SubscriptionUnschedulePendingPlanChangesParams
 
-  SubscriptionUpdateFixedFeeQuantityParams = Orb::Models::SubscriptionUpdateFixedFeeQuantityParams
+  SubscriptionUpdateFixedFeeQuantityParams =
+    Orb::Models::SubscriptionUpdateFixedFeeQuantityParams
 
   SubscriptionUpdateParams = Orb::Models::SubscriptionUpdateParams
 

data/rbi/orb/request_options.rbi

@@ -1,17 +1,18 @@
 # typed: strong
 
 module Orb
-  RequestOpts = T.type_alias { T.any(Orb::RequestOptions, Orb::Internal::AnyHash) }
-
   # Specify HTTP behaviour to use for a specific request. These options supplement
   # or override those provided at the client level.
   #
   # When making a request, you can pass an actual {RequestOptions} instance, or
   # simply pass a Hash with symbol keys matching the attributes on this class.
   class RequestOptions < Orb::Internal::Type::BaseModel
+    OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
+
     # @api private
-    sig { params(opts: T.any(T.self_type, T::Hash[Symbol, T.anything])).void }
-    def self.validate!(opts); end
+    sig { params(opts: Orb::RequestOptions::OrHash).void }
+    def self.validate!(opts)
+    end
 
     # Idempotency key to send with request and all associated retries. Will only be
     # sent for write requests.
@@ -20,7 +21,11 @@ module Orb
 
     # Extra query params to send with the request. These are `.merge`’d into any
     # `query` given at the client level.
-    sig { returns(T.nilable(T::Hash[String, T.nilable(T.any(T::Array[String], String))])) }
+    sig do
+      returns(
+        T.nilable(T::Hash[String, T.nilable(T.any(T::Array[String], String))])
+      )
+    end
     attr_accessor :extra_query
 
     # Extra headers to send with the request. These are `.merged`’d into any
@@ -43,6 +48,7 @@ module Orb
 
     # Returns a new instance of RequestOptions.
     sig { params(values: Orb::Internal::AnyHash).returns(T.attached_class) }
-    def self.new(values = {}); end
+    def self.new(values = {})
+    end
   end
 end

data/rbi/orb/resources/alerts.rbi

@@ -4,24 +4,31 @@ module Orb
   module Resources
     class Alerts
       # This endpoint retrieves an alert by its ID.
-      sig { params(alert_id: String, request_options: Orb::RequestOpts).returns(Orb::Models::Alert) }
-      def retrieve(alert_id, request_options: {}); end
+      sig do
+        params(
+          alert_id: String,
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(Orb::Alert)
+      end
+      def retrieve(alert_id, request_options: {})
+      end
 
       # This endpoint updates the thresholds of an alert.
       sig do
         params(
           alert_configuration_id: String,
-          thresholds: T::Array[T.any(Orb::Models::AlertUpdateParams::Threshold, Orb::Internal::AnyHash)],
-          request_options: Orb::RequestOpts
-        )
-          .returns(Orb::Models::Alert)
+          thresholds: T::Array[Orb::AlertUpdateParams::Threshold::OrHash],
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(Orb::Alert)
       end
       def update(
         alert_configuration_id,
         # The thresholds that define the values at which the alert will be triggered.
         thresholds:,
         request_options: {}
-      ); end
+      )
+      end
+
       # This endpoint returns a list of alerts within Orb.
       #
       # The request must specify one of `customer_id`, `external_customer_id`, or
@@ -44,9 +51,8 @@ module Orb
           external_customer_id: T.nilable(String),
           limit: Integer,
           subscription_id: T.nilable(String),
-          request_options: Orb::RequestOpts
-        )
-          .returns(Orb::Internal::Page[Orb::Models::Alert])
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(Orb::Internal::Page[Orb::Alert])
       end
       def list(
         created_at_gt: nil,
@@ -65,7 +71,9 @@ module Orb
         # Fetch alerts scoped to this subscription_id
         subscription_id: nil,
         request_options: {}
-      ); end
+      )
+      end
+
       # This endpoint creates a new alert to monitor a customer's credit balance. There
       # are three types of alerts that can be scoped to customers:
       # `credit_balance_depleted`, `credit_balance_dropped`, and
@@ -78,11 +86,13 @@ module Orb
         params(
           customer_id: String,
           currency: String,
-          type: Orb::Models::AlertCreateForCustomerParams::Type::OrSymbol,
-          thresholds: T.nilable(T::Array[T.any(Orb::Models::AlertCreateForCustomerParams::Threshold, Orb::Internal::AnyHash)]),
-          request_options: Orb::RequestOpts
-        )
-          .returns(Orb::Models::Alert)
+          type: Orb::AlertCreateForCustomerParams::Type::OrSymbol,
+          thresholds:
+            T.nilable(
+              T::Array[Orb::AlertCreateForCustomerParams::Threshold::OrHash]
+            ),
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(Orb::Alert)
       end
       def create_for_customer(
         customer_id,
@@ -93,7 +103,9 @@ module Orb
         # The thresholds that define the values at which the alert will be triggered.
         thresholds: nil,
         request_options: {}
-      ); end
+      )
+      end
+
       # This endpoint creates a new alert to monitor a customer's credit balance. There
       # are three types of alerts that can be scoped to customers:
       # `credit_balance_depleted`, `credit_balance_dropped`, and
@@ -106,13 +118,15 @@ module Orb
         params(
           external_customer_id: String,
           currency: String,
-          type: Orb::Models::AlertCreateForExternalCustomerParams::Type::OrSymbol,
-          thresholds: T.nilable(
-            T::Array[T.any(Orb::Models::AlertCreateForExternalCustomerParams::Threshold, Orb::Internal::AnyHash)]
-          ),
-          request_options: Orb::RequestOpts
-        )
-          .returns(Orb::Models::Alert)
+          type: Orb::AlertCreateForExternalCustomerParams::Type::OrSymbol,
+          thresholds:
+            T.nilable(
+              T::Array[
+                Orb::AlertCreateForExternalCustomerParams::Threshold::OrHash
+              ]
+            ),
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(Orb::Alert)
       end
       def create_for_external_customer(
         external_customer_id,
@@ -123,7 +137,9 @@ module Orb
         # The thresholds that define the values at which the alert will be triggered.
         thresholds: nil,
         request_options: {}
-      ); end
+      )
+      end
+
       # This endpoint is used to create alerts at the subscription level.
       #
       # Subscription level alerts can be one of two types: `usage_exceeded` or
@@ -138,12 +154,12 @@ module Orb
       sig do
         params(
           subscription_id: String,
-          thresholds: T::Array[T.any(Orb::Models::AlertCreateForSubscriptionParams::Threshold, Orb::Internal::AnyHash)],
-          type: Orb::Models::AlertCreateForSubscriptionParams::Type::OrSymbol,
+          thresholds:
+            T::Array[Orb::AlertCreateForSubscriptionParams::Threshold::OrHash],
+          type: Orb::AlertCreateForSubscriptionParams::Type::OrSymbol,
           metric_id: T.nilable(String),
-          request_options: Orb::RequestOpts
-        )
-          .returns(Orb::Models::Alert)
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(Orb::Alert)
       end
       def create_for_subscription(
         subscription_id,
@@ -154,7 +170,9 @@ module Orb
         # The metric to track usage for.
         metric_id: nil,
         request_options: {}
-      ); end
+      )
+      end
+
       # This endpoint allows you to disable an alert. To disable a plan-level alert for
       # a specific subscription, you must include the `subscription_id`. The
       # `subscription_id` is not required for customer or subscription level alerts.
@@ -162,16 +180,17 @@ module Orb
         params(
           alert_configuration_id: String,
           subscription_id: T.nilable(String),
-          request_options: Orb::RequestOpts
-        )
-          .returns(Orb::Models::Alert)
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(Orb::Alert)
       end
       def disable(
         alert_configuration_id,
         # Used to update the status of a plan alert scoped to this subscription_id
         subscription_id: nil,
         request_options: {}
-      ); end
+      )
+      end
+
       # This endpoint allows you to enable an alert. To enable a plan-level alert for a
       # specific subscription, you must include the `subscription_id`. The
       # `subscription_id` is not required for customer or subscription level alerts.
@@ -179,19 +198,21 @@ module Orb
         params(
           alert_configuration_id: String,
           subscription_id: T.nilable(String),
-          request_options: Orb::RequestOpts
-        )
-          .returns(Orb::Models::Alert)
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(Orb::Alert)
       end
       def enable(
         alert_configuration_id,
         # Used to update the status of a plan alert scoped to this subscription_id
         subscription_id: nil,
         request_options: {}
-      ); end
+      )
+      end
+
       # @api private
       sig { params(client: Orb::Client).returns(T.attached_class) }
-      def self.new(client:); end
+      def self.new(client:)
+      end
     end
   end
 end

data/rbi/orb/resources/coupons/subscriptions.rbi

@@ -13,9 +13,8 @@ module Orb
             coupon_id: String,
             cursor: T.nilable(String),
             limit: Integer,
-            request_options: Orb::RequestOpts
-          )
-            .returns(Orb::Internal::Page[Orb::Models::Subscription])
+            request_options: Orb::RequestOptions::OrHash
+          ).returns(Orb::Internal::Page[Orb::Subscription])
         end
         def list(
           coupon_id,
@@ -25,10 +24,13 @@ module Orb
           # The number of items to fetch. Defaults to 20.
           limit: nil,
           request_options: {}
-        ); end
+        )
+        end
+
         # @api private
         sig { params(client: Orb::Client).returns(T.attached_class) }
-        def self.new(client:); end
+        def self.new(client:)
+        end
       end
     end
   end

data/rbi/orb/resources/coupons.rbi

@@ -10,17 +10,16 @@ module Orb
       # subscription creation or plan change.
       sig do
         params(
-          discount: T.any(
-            Orb::Models::CouponCreateParams::Discount::Percentage,
-            Orb::Internal::AnyHash,
-            Orb::Models::CouponCreateParams::Discount::Amount
-          ),
+          discount:
+            T.any(
+              Orb::CouponCreateParams::Discount::Percentage::OrHash,
+              Orb::CouponCreateParams::Discount::Amount::OrHash
+            ),
           redemption_code: String,
           duration_in_months: T.nilable(Integer),
           max_redemptions: T.nilable(Integer),
-          request_options: Orb::RequestOpts
-        )
-          .returns(Orb::Models::Coupon)
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(Orb::Coupon)
       end
       def create(
         discount:,
@@ -33,7 +32,9 @@ module Orb
         # exhausted;`null` here means "unlimited".
         max_redemptions: nil,
         request_options: {}
-      ); end
+      )
+      end
+
       # This endpoint returns a list of all coupons for an account in a list format.
       #
       # The list of coupons is ordered starting from the most recently created coupon.
@@ -46,9 +47,8 @@ module Orb
           limit: Integer,
           redemption_code: T.nilable(String),
           show_archived: T.nilable(T::Boolean),
-          request_options: Orb::RequestOpts
-        )
-          .returns(Orb::Internal::Page[Orb::Models::Coupon])
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(Orb::Internal::Page[Orb::Coupon])
       end
       def list(
         # Cursor for pagination. This can be populated by the `next_cursor` value returned
@@ -62,22 +62,37 @@ module Orb
         # coupons).
         show_archived: nil,
         request_options: {}
-      ); end
+      )
+      end
+
       # This endpoint allows a coupon to be archived. Archived coupons can no longer be
       # redeemed, and will be hidden from lists of active coupons. Additionally, once a
       # coupon is archived, its redemption code can be reused for a different coupon.
-      sig { params(coupon_id: String, request_options: Orb::RequestOpts).returns(Orb::Models::Coupon) }
-      def archive(coupon_id, request_options: {}); end
+      sig do
+        params(
+          coupon_id: String,
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(Orb::Coupon)
+      end
+      def archive(coupon_id, request_options: {})
+      end
 
       # This endpoint retrieves a coupon by its ID. To fetch coupons by their redemption
       # code, use the [List coupons](list-coupons) endpoint with the redemption_code
       # parameter.
-      sig { params(coupon_id: String, request_options: Orb::RequestOpts).returns(Orb::Models::Coupon) }
-      def fetch(coupon_id, request_options: {}); end
+      sig do
+        params(
+          coupon_id: String,
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(Orb::Coupon)
+      end
+      def fetch(coupon_id, request_options: {})
+      end
 
       # @api private
       sig { params(client: Orb::Client).returns(T.attached_class) }
-      def self.new(client:); end
+      def self.new(client:)
+      end
     end
   end
 end