orb-billing 0.3.1 → 0.3.2

data/rbi/orb/resources/subscriptions.rbi

@@ -261,21 +261,31 @@ module Orb
       # $10.00 for a subscription that invoices in USD.
       sig do
         params(
-          add_adjustments: T.nilable(T::Array[T.any(Orb::Models::SubscriptionCreateParams::AddAdjustment, Orb::Internal::AnyHash)]),
-          add_prices: T.nilable(T::Array[T.any(Orb::Models::SubscriptionCreateParams::AddPrice, Orb::Internal::AnyHash)]),
+          add_adjustments:
+            T.nilable(
+              T::Array[Orb::SubscriptionCreateParams::AddAdjustment::OrHash]
+            ),
+          add_prices:
+            T.nilable(
+              T::Array[Orb::SubscriptionCreateParams::AddPrice::OrHash]
+            ),
           align_billing_with_subscription_start_date: T::Boolean,
           auto_collection: T.nilable(T::Boolean),
           aws_region: T.nilable(String),
-          billing_cycle_anchor_configuration: T.nilable(
-            T.any(Orb::Models::SubscriptionCreateParams::BillingCycleAnchorConfiguration, Orb::Internal::AnyHash)
-          ),
+          billing_cycle_anchor_configuration:
+            T.nilable(
+              Orb::SubscriptionCreateParams::BillingCycleAnchorConfiguration::OrHash
+            ),
           coupon_redemption_code: T.nilable(String),
           credits_overage_rate: T.nilable(Float),
           customer_id: T.nilable(String),
           default_invoice_memo: T.nilable(String),
           end_date: T.nilable(Time),
           external_customer_id: T.nilable(String),
-          external_marketplace: T.nilable(Orb::Models::SubscriptionCreateParams::ExternalMarketplace::OrSymbol),
+          external_marketplace:
+            T.nilable(
+              Orb::SubscriptionCreateParams::ExternalMarketplace::OrSymbol
+            ),
           external_marketplace_reporting_id: T.nilable(String),
           external_plan_id: T.nilable(String),
           filter: T.nilable(String),
@@ -287,20 +297,27 @@ module Orb
           plan_id: T.nilable(String),
           plan_version_number: T.nilable(Integer),
           price_overrides: T.nilable(T::Array[T.anything]),
-          remove_adjustments: T.nilable(
-            T::Array[T.any(Orb::Models::SubscriptionCreateParams::RemoveAdjustment, Orb::Internal::AnyHash)]
-          ),
-          remove_prices: T.nilable(T::Array[T.any(Orb::Models::SubscriptionCreateParams::RemovePrice, Orb::Internal::AnyHash)]),
-          replace_adjustments: T.nilable(
-            T::Array[T.any(Orb::Models::SubscriptionCreateParams::ReplaceAdjustment, Orb::Internal::AnyHash)]
-          ),
-          replace_prices: T.nilable(T::Array[T.any(Orb::Models::SubscriptionCreateParams::ReplacePrice, Orb::Internal::AnyHash)]),
+          remove_adjustments:
+            T.nilable(
+              T::Array[Orb::SubscriptionCreateParams::RemoveAdjustment::OrHash]
+            ),
+          remove_prices:
+            T.nilable(
+              T::Array[Orb::SubscriptionCreateParams::RemovePrice::OrHash]
+            ),
+          replace_adjustments:
+            T.nilable(
+              T::Array[Orb::SubscriptionCreateParams::ReplaceAdjustment::OrHash]
+            ),
+          replace_prices:
+            T.nilable(
+              T::Array[Orb::SubscriptionCreateParams::ReplacePrice::OrHash]
+            ),
           start_date: T.nilable(Time),
           trial_duration_days: T.nilable(Integer),
           usage_customer_ids: T.nilable(T::Array[String]),
-          request_options: Orb::RequestOpts
-        )
-          .returns(Orb::Models::SubscriptionCreateResponse)
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(Orb::Models::SubscriptionCreateResponse)
       end
       def create(
         # Additional adjustments to be added to the subscription. (Only available for
@@ -386,7 +403,9 @@ module Orb
         # subscription itself, or any of that customer's children.
         usage_customer_ids: nil,
         request_options: {}
-      ); end
+      )
+      end
+
       # This endpoint can be used to update the `metadata`, `net terms`,
       # `auto_collection`, `invoicing_threshold`, and `default_invoice_memo` properties
       # on a subscription.
@@ -398,9 +417,8 @@ module Orb
           invoicing_threshold: T.nilable(String),
           metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
           net_terms: T.nilable(Integer),
-          request_options: Orb::RequestOpts
-        )
-          .returns(Orb::Models::Subscription)
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(Orb::Subscription)
       end
       def update(
         subscription_id,
@@ -425,7 +443,9 @@ module Orb
         # has a month to pay the invoice.
         net_terms: nil,
         request_options: {}
-      ); end
+      )
+      end
+
       # This endpoint returns a list of all subscriptions for an account as a
       # [paginated](/api-reference/pagination) list, ordered starting from the most
       # recently created subscription. For a full discussion of the subscription
@@ -445,10 +465,9 @@ module Orb
           customer_id: T.nilable(T::Array[String]),
           external_customer_id: T.nilable(T::Array[String]),
           limit: Integer,
-          status: T.nilable(Orb::Models::SubscriptionListParams::Status::OrSymbol),
-          request_options: Orb::RequestOpts
-        )
-          .returns(Orb::Internal::Page[Orb::Models::Subscription])
+          status: T.nilable(Orb::SubscriptionListParams::Status::OrSymbol),
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(Orb::Internal::Page[Orb::Subscription])
       end
       def list(
         created_at_gt: nil,
@@ -464,7 +483,9 @@ module Orb
         limit: nil,
         status: nil,
         request_options: {}
-      ); end
+      )
+      end
+
       # This endpoint can be used to cancel an existing subscription. It returns the
       # serialized subscription object with an `end_date` parameter that signifies when
       # the subscription will transition to an ended state.
@@ -529,12 +550,11 @@ module Orb
       sig do
         params(
           subscription_id: String,
-          cancel_option: Orb::Models::SubscriptionCancelParams::CancelOption::OrSymbol,
+          cancel_option: Orb::SubscriptionCancelParams::CancelOption::OrSymbol,
           allow_invoice_credit_or_void: T.nilable(T::Boolean),
           cancellation_date: T.nilable(Time),
-          request_options: Orb::RequestOpts
-        )
-          .returns(Orb::Models::SubscriptionCancelResponse)
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(Orb::Models::SubscriptionCancelResponse)
       end
       def cancel(
         subscription_id,
@@ -548,11 +568,19 @@ module Orb
         # passed if the `cancel_option` is `requested_date`.
         cancellation_date: nil,
         request_options: {}
-      ); end
+      )
+      end
+
       # This endpoint is used to fetch a [Subscription](/core-concepts##subscription)
       # given an identifier.
-      sig { params(subscription_id: String, request_options: Orb::RequestOpts).returns(Orb::Models::Subscription) }
-      def fetch(subscription_id, request_options: {}); end
+      sig do
+        params(
+          subscription_id: String,
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(Orb::Subscription)
+      end
+      def fetch(subscription_id, request_options: {})
+      end
 
       # This endpoint is used to fetch a day-by-day snapshot of a subscription's costs
       # in Orb, calculated by applying pricing information to the underlying usage (see
@@ -570,10 +598,10 @@ module Orb
           currency: T.nilable(String),
           timeframe_end: T.nilable(Time),
           timeframe_start: T.nilable(Time),
-          view_mode: T.nilable(Orb::Models::SubscriptionFetchCostsParams::ViewMode::OrSymbol),
-          request_options: Orb::RequestOpts
-        )
-          .returns(Orb::Models::SubscriptionFetchCostsResponse)
+          view_mode:
+            T.nilable(Orb::SubscriptionFetchCostsParams::ViewMode::OrSymbol),
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(Orb::Models::SubscriptionFetchCostsResponse)
       end
       def fetch_costs(
         subscription_id,
@@ -589,7 +617,9 @@ module Orb
         # behavior.
         view_mode: nil,
         request_options: {}
-      ); end
+      )
+      end
+
       # This endpoint returns a [paginated](/api-reference/pagination) list of all plans
       # associated with a subscription along with their start and end dates. This list
       # contains the subscription's initial plan along with past and future plan
@@ -603,9 +633,10 @@ module Orb
           start_date_gte: T.nilable(Time),
           start_date_lt: T.nilable(Time),
           start_date_lte: T.nilable(Time),
-          request_options: Orb::RequestOpts
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(
+          Orb::Internal::Page[Orb::Models::SubscriptionFetchScheduleResponse]
         )
-          .returns(Orb::Internal::Page[Orb::Models::SubscriptionFetchScheduleResponse])
       end
       def fetch_schedule(
         subscription_id,
@@ -619,7 +650,9 @@ module Orb
         start_date_lt: nil,
         start_date_lte: nil,
         request_options: {}
-      ); end
+      )
+      end
+
       # This endpoint is used to fetch a subscription's usage in Orb. Especially when
       # combined with optional query parameters, this endpoint is a powerful way to
       # build visualizations on top of Orb's event data and metrics.
@@ -820,21 +853,22 @@ module Orb
           billable_metric_id: T.nilable(String),
           first_dimension_key: T.nilable(String),
           first_dimension_value: T.nilable(String),
-          granularity: T.nilable(Orb::Models::SubscriptionFetchUsageParams::Granularity::OrSymbol),
+          granularity:
+            T.nilable(Orb::SubscriptionFetchUsageParams::Granularity::OrSymbol),
           group_by: T.nilable(String),
           second_dimension_key: T.nilable(String),
           second_dimension_value: T.nilable(String),
           timeframe_end: T.nilable(Time),
           timeframe_start: T.nilable(Time),
-          view_mode: T.nilable(Orb::Models::SubscriptionFetchUsageParams::ViewMode::OrSymbol),
-          request_options: Orb::RequestOpts
-        )
-          .returns(
-            T.any(
-              Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage,
-              Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage
-            )
+          view_mode:
+            T.nilable(Orb::SubscriptionFetchUsageParams::ViewMode::OrSymbol),
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(
+          T.any(
+            Orb::SubscriptionUsage::UngroupedSubscriptionUsage,
+            Orb::SubscriptionUsage::GroupedSubscriptionUsage
           )
+        )
       end
       def fetch_usage(
         subscription_id,
@@ -860,7 +894,9 @@ module Orb
         # behavior.
         view_mode: nil,
         request_options: {}
-      ); end
+      )
+      end
+
       # This endpoint is used to add and edit subscription
       # [price intervals](/api-reference/price-interval/add-or-edit-price-intervals). By
       # making modifications to a subscription’s price intervals, you can
@@ -936,14 +972,19 @@ module Orb
       sig do
         params(
           subscription_id: String,
-          add: T::Array[T.any(Orb::Models::SubscriptionPriceIntervalsParams::Add, Orb::Internal::AnyHash)],
-          add_adjustments: T::Array[T.any(Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment, Orb::Internal::AnyHash)],
+          add: T::Array[Orb::SubscriptionPriceIntervalsParams::Add::OrHash],
+          add_adjustments:
+            T::Array[
+              Orb::SubscriptionPriceIntervalsParams::AddAdjustment::OrHash
+            ],
           allow_invoice_credit_or_void: T.nilable(T::Boolean),
-          edit: T::Array[T.any(Orb::Models::SubscriptionPriceIntervalsParams::Edit, Orb::Internal::AnyHash)],
-          edit_adjustments: T::Array[T.any(Orb::Models::SubscriptionPriceIntervalsParams::EditAdjustment, Orb::Internal::AnyHash)],
-          request_options: Orb::RequestOpts
-        )
-          .returns(Orb::Models::SubscriptionPriceIntervalsResponse)
+          edit: T::Array[Orb::SubscriptionPriceIntervalsParams::Edit::OrHash],
+          edit_adjustments:
+            T::Array[
+              Orb::SubscriptionPriceIntervalsParams::EditAdjustment::OrHash
+            ],
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(Orb::Models::SubscriptionPriceIntervalsResponse)
       end
       def price_intervals(
         subscription_id,
@@ -960,7 +1001,9 @@ module Orb
         # A list of adjustments to edit on the subscription.
         edit_adjustments: nil,
         request_options: {}
-      ); end
+      )
+      end
+
       # This endpoint can be used to change an existing subscription's plan. It returns
       # the serialized updated subscription object.
       #
@@ -1147,22 +1190,30 @@ module Orb
       sig do
         params(
           subscription_id: String,
-          change_option: Orb::Models::SubscriptionSchedulePlanChangeParams::ChangeOption::OrSymbol,
-          add_adjustments: T.nilable(
-            T::Array[T.any(Orb::Models::SubscriptionSchedulePlanChangeParams::AddAdjustment, Orb::Internal::AnyHash)]
-          ),
-          add_prices: T.nilable(
-            T::Array[T.any(Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice, Orb::Internal::AnyHash)]
-          ),
+          change_option:
+            Orb::SubscriptionSchedulePlanChangeParams::ChangeOption::OrSymbol,
+          add_adjustments:
+            T.nilable(
+              T::Array[
+                Orb::SubscriptionSchedulePlanChangeParams::AddAdjustment::OrHash
+              ]
+            ),
+          add_prices:
+            T.nilable(
+              T::Array[
+                Orb::SubscriptionSchedulePlanChangeParams::AddPrice::OrHash
+              ]
+            ),
           align_billing_with_plan_change_date: T.nilable(T::Boolean),
           auto_collection: T.nilable(T::Boolean),
-          billing_cycle_alignment: T.nilable(Orb::Models::SubscriptionSchedulePlanChangeParams::BillingCycleAlignment::OrSymbol),
-          billing_cycle_anchor_configuration: T.nilable(
-            T.any(
-              Orb::Models::SubscriptionSchedulePlanChangeParams::BillingCycleAnchorConfiguration,
-              Orb::Internal::AnyHash
-            )
-          ),
+          billing_cycle_alignment:
+            T.nilable(
+              Orb::SubscriptionSchedulePlanChangeParams::BillingCycleAlignment::OrSymbol
+            ),
+          billing_cycle_anchor_configuration:
+            T.nilable(
+              Orb::SubscriptionSchedulePlanChangeParams::BillingCycleAnchorConfiguration::OrHash
+            ),
           change_date: T.nilable(Time),
           coupon_redemption_code: T.nilable(String),
           credits_overage_rate: T.nilable(Float),
@@ -1176,23 +1227,34 @@ module Orb
           plan_id: T.nilable(String),
           plan_version_number: T.nilable(Integer),
           price_overrides: T.nilable(T::Array[T.anything]),
-          remove_adjustments: T.nilable(
-            T::Array[T.any(Orb::Models::SubscriptionSchedulePlanChangeParams::RemoveAdjustment, Orb::Internal::AnyHash)]
-          ),
-          remove_prices: T.nilable(
-            T::Array[T.any(Orb::Models::SubscriptionSchedulePlanChangeParams::RemovePrice, Orb::Internal::AnyHash)]
-          ),
-          replace_adjustments: T.nilable(
-            T::Array[T.any(Orb::Models::SubscriptionSchedulePlanChangeParams::ReplaceAdjustment, Orb::Internal::AnyHash)]
-          ),
-          replace_prices: T.nilable(
-            T::Array[T.any(Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice, Orb::Internal::AnyHash)]
-          ),
+          remove_adjustments:
+            T.nilable(
+              T::Array[
+                Orb::SubscriptionSchedulePlanChangeParams::RemoveAdjustment::OrHash
+              ]
+            ),
+          remove_prices:
+            T.nilable(
+              T::Array[
+                Orb::SubscriptionSchedulePlanChangeParams::RemovePrice::OrHash
+              ]
+            ),
+          replace_adjustments:
+            T.nilable(
+              T::Array[
+                Orb::SubscriptionSchedulePlanChangeParams::ReplaceAdjustment::OrHash
+              ]
+            ),
+          replace_prices:
+            T.nilable(
+              T::Array[
+                Orb::SubscriptionSchedulePlanChangeParams::ReplacePrice::OrHash
+              ]
+            ),
           trial_duration_days: T.nilable(Integer),
           usage_customer_ids: T.nilable(T::Array[String]),
-          request_options: Orb::RequestOpts
-        )
-          .returns(Orb::Models::SubscriptionSchedulePlanChangeResponse)
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(Orb::Models::SubscriptionSchedulePlanChangeResponse)
       end
       def schedule_plan_change(
         subscription_id,
@@ -1279,7 +1341,9 @@ module Orb
         # subscription itself, or any of that customer's children.
         usage_customer_ids: nil,
         request_options: {}
-      ); end
+      )
+      end
+
       # Manually trigger a phase, effective the given date (or the current time, if not
       # specified).
       sig do
@@ -1287,9 +1351,8 @@ module Orb
           subscription_id: String,
           allow_invoice_credit_or_void: T.nilable(T::Boolean),
           effective_date: T.nilable(Date),
-          request_options: Orb::RequestOpts
-        )
-          .returns(Orb::Models::SubscriptionTriggerPhaseResponse)
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(Orb::Models::SubscriptionTriggerPhaseResponse)
       end
       def trigger_phase(
         subscription_id,
@@ -1301,7 +1364,9 @@ module Orb
         # to today in the customer's timezone.
         effective_date: nil,
         request_options: {}
-      ); end
+      )
+      end
+
       # This endpoint can be used to unschedule any pending cancellations for a
       # subscription.
       #
@@ -1309,10 +1374,13 @@ module Orb
       # cancellation. This operation will turn on auto-renew, ensuring that the
       # subscription does not end at the currently scheduled cancellation time.
       sig do
-        params(subscription_id: String, request_options: Orb::RequestOpts)
-          .returns(Orb::Models::SubscriptionUnscheduleCancellationResponse)
+        params(
+          subscription_id: String,
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(Orb::Models::SubscriptionUnscheduleCancellationResponse)
+      end
+      def unschedule_cancellation(subscription_id, request_options: {})
       end
-      def unschedule_cancellation(subscription_id, request_options: {}); end
 
       # This endpoint can be used to clear scheduled updates to the quantity for a fixed
       # fee.
@@ -1320,22 +1388,32 @@ module Orb
       # If there are no updates scheduled, a request validation error will be returned
       # with a 400 status code.
       sig do
-        params(subscription_id: String, price_id: String, request_options: Orb::RequestOpts)
-          .returns(Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse)
+        params(
+          subscription_id: String,
+          price_id: String,
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(
+          Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse
+        )
       end
       def unschedule_fixed_fee_quantity_updates(
         subscription_id,
         # Price for which the updates should be cleared. Must be a fixed fee.
         price_id:,
         request_options: {}
-      ); end
+      )
+      end
+
       # This endpoint can be used to unschedule any pending plan changes on an existing
       # subscription.
       sig do
-        params(subscription_id: String, request_options: Orb::RequestOpts)
-          .returns(Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse)
+        params(
+          subscription_id: String,
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(Orb::Models::SubscriptionUnschedulePendingPlanChangesResponse)
+      end
+      def unschedule_pending_plan_changes(subscription_id, request_options: {})
       end
-      def unschedule_pending_plan_changes(subscription_id, request_options: {}); end
 
       # This endpoint can be used to update the quantity for a fixed fee.
       #
@@ -1357,11 +1435,11 @@ module Orb
           price_id: String,
           quantity: Float,
           allow_invoice_credit_or_void: T.nilable(T::Boolean),
-          change_option: Orb::Models::SubscriptionUpdateFixedFeeQuantityParams::ChangeOption::OrSymbol,
+          change_option:
+            Orb::SubscriptionUpdateFixedFeeQuantityParams::ChangeOption::OrSymbol,
           effective_date: T.nilable(Date),
-          request_options: Orb::RequestOpts
-        )
-          .returns(Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse)
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(Orb::Models::SubscriptionUpdateFixedFeeQuantityResponse)
       end
       def update_fixed_fee_quantity(
         subscription_id,
@@ -1381,7 +1459,9 @@ module Orb
         # effective according to `change_option`.
         effective_date: nil,
         request_options: {}
-      ); end
+      )
+      end
+
       # This endpoint is used to update the trial end date for a subscription. The new
       # trial end date must be within the time range of the current plan (i.e. the new
       # trial end date must be on or after the subscription's start date on the current
@@ -1403,11 +1483,14 @@ module Orb
       sig do
         params(
           subscription_id: String,
-          trial_end_date: T.any(Time, Orb::Models::SubscriptionUpdateTrialParams::TrialEndDate::OrSymbol),
+          trial_end_date:
+            T.any(
+              Time,
+              Orb::SubscriptionUpdateTrialParams::TrialEndDate::OrSymbol
+            ),
           shift: T::Boolean,
-          request_options: Orb::RequestOpts
-        )
-          .returns(Orb::Models::SubscriptionUpdateTrialResponse)
+          request_options: Orb::RequestOptions::OrHash
+        ).returns(Orb::Models::SubscriptionUpdateTrialResponse)
       end
       def update_trial(
         subscription_id,
@@ -1418,10 +1501,13 @@ module Orb
         # durations, but adjusting their absolute dates).
         shift: 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/top_level.rbi

@@ -9,12 +9,18 @@ module Orb
       # is a great choice for connectors and integrations.
       #
       # This API does not have any side-effects or return any Orb resources.
-      sig { params(request_options: Orb::RequestOpts).returns(Orb::Models::TopLevelPingResponse) }
-      def ping(request_options: {}); end
+      sig do
+        params(request_options: Orb::RequestOptions::OrHash).returns(
+          Orb::Models::TopLevelPingResponse
+        )
+      end
+      def ping(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

data/sig/orb/internal/page.rbs

@@ -16,8 +16,6 @@ module Orb
         attr_accessor next_cursor: String?
 
         def initialize: (has_more: bool, next_cursor: String?) -> void
-
-        def to_hash: -> pagination_metadata
       end
     end
   end

data/sig/orb/internal/type/request_parameters.rbs

@@ -4,7 +4,9 @@ module Orb
       type request_parameters = { request_options: Orb::request_opts }
 
       module RequestParameters
-        attr_accessor request_options: Orb::request_opts
+        attr_reader request_options: Orb::request_opts
+
+        def request_options=: (Orb::request_opts) -> Orb::request_opts
 
         module Converter
           def dump_request: (top params) -> [top, ::Hash[Symbol, top]]