orb-billing 0.5.2 → 0.5.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (279) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +12 -0
  3. data/README.md +4 -4
  4. data/SECURITY.md +2 -2
  5. data/lib/orb/internal.rb +3 -0
  6. data/lib/orb/models/alert.rb +23 -23
  7. data/lib/orb/models/alert_create_for_customer_params.rb +5 -5
  8. data/lib/orb/models/alert_create_for_external_customer_params.rb +5 -5
  9. data/lib/orb/models/alert_create_for_subscription_params.rb +5 -5
  10. data/lib/orb/models/alert_update_params.rb +3 -3
  11. data/lib/orb/models/amount_discount.rb +5 -5
  12. data/lib/orb/models/billable_metric.rb +7 -7
  13. data/lib/orb/models/coupon.rb +6 -6
  14. data/lib/orb/models/coupon_create_params.rb +3 -3
  15. data/lib/orb/models/credit_note.rb +33 -33
  16. data/lib/orb/models/credit_note_create_params.rb +4 -4
  17. data/lib/orb/models/customer.rb +39 -39
  18. data/lib/orb/models/customer_create_params.rb +26 -26
  19. data/lib/orb/models/customer_update_by_external_id_params.rb +26 -26
  20. data/lib/orb/models/customer_update_params.rb +26 -26
  21. data/lib/orb/models/customers/balance_transaction_create_params.rb +2 -2
  22. data/lib/orb/models/customers/cost_list_by_external_id_params.rb +2 -2
  23. data/lib/orb/models/customers/cost_list_by_external_id_response.rb +2 -2
  24. data/lib/orb/models/customers/cost_list_params.rb +2 -2
  25. data/lib/orb/models/customers/cost_list_response.rb +2 -2
  26. data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +7 -7
  27. data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +8 -8
  28. data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +4 -4
  29. data/lib/orb/models/customers/credits/ledger_list_params.rb +4 -4
  30. data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +6 -6
  31. data/lib/orb/models/customers/credits/top_up_create_params.rb +6 -5
  32. data/lib/orb/models/dimensional_price_group.rb +1 -1
  33. data/lib/orb/models/dimensional_price_groups.rb +4 -4
  34. data/lib/orb/models/discount.rb +1 -1
  35. data/lib/orb/models/event_ingest_params.rb +3 -3
  36. data/lib/orb/models/events/event_volumes.rb +2 -2
  37. data/lib/orb/models/invoice.rb +114 -113
  38. data/lib/orb/models/invoice_create_params.rb +10 -10
  39. data/lib/orb/models/invoice_fetch_upcoming_response.rb +6 -6
  40. data/lib/orb/models/invoice_level_discount.rb +1 -1
  41. data/lib/orb/models/invoice_line_item_create_response.rb +4 -4
  42. data/lib/orb/models/invoice_list_params.rb +4 -4
  43. data/lib/orb/models/item.rb +5 -5
  44. data/lib/orb/models/item_update_params.rb +5 -5
  45. data/lib/orb/models/percentage_discount.rb +5 -5
  46. data/lib/orb/models/plan.rb +58 -58
  47. data/lib/orb/models/plan_create_params.rb +448 -444
  48. data/lib/orb/models/plan_list_params.rb +2 -2
  49. data/lib/orb/models/price.rb +1204 -1204
  50. data/lib/orb/models/price_create_params.rb +50 -50
  51. data/lib/orb/models/price_evaluate_response.rb +2 -2
  52. data/lib/orb/models/subscription.rb +58 -56
  53. data/lib/orb/models/subscription_cancel_params.rb +2 -2
  54. data/lib/orb/models/subscription_cancel_response.rb +14 -14
  55. data/lib/orb/models/subscription_change_apply_response.rb +14 -14
  56. data/lib/orb/models/subscription_change_cancel_response.rb +14 -14
  57. data/lib/orb/models/subscription_change_retrieve_response.rb +14 -14
  58. data/lib/orb/models/subscription_create_params.rb +1002 -987
  59. data/lib/orb/models/subscription_create_response.rb +14 -14
  60. data/lib/orb/models/subscription_fetch_costs_params.rb +2 -2
  61. data/lib/orb/models/subscription_fetch_costs_response.rb +2 -2
  62. data/lib/orb/models/subscription_fetch_usage_params.rb +4 -4
  63. data/lib/orb/models/subscription_list_params.rb +2 -2
  64. data/lib/orb/models/subscription_price_intervals_params.rb +596 -585
  65. data/lib/orb/models/subscription_price_intervals_response.rb +14 -14
  66. data/lib/orb/models/subscription_schedule_plan_change_params.rb +973 -971
  67. data/lib/orb/models/subscription_schedule_plan_change_response.rb +14 -14
  68. data/lib/orb/models/subscription_trigger_phase_response.rb +14 -14
  69. data/lib/orb/models/subscription_unschedule_cancellation_response.rb +14 -14
  70. data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +14 -14
  71. data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +14 -14
  72. data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +2 -2
  73. data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +14 -14
  74. data/lib/orb/models/subscription_update_trial_params.rb +3 -3
  75. data/lib/orb/models/subscription_update_trial_response.rb +14 -14
  76. data/lib/orb/models/subscription_usage.rb +26 -26
  77. data/lib/orb/models/subscriptions.rb +4 -4
  78. data/lib/orb/models/trial_discount.rb +5 -5
  79. data/lib/orb/models/usage_discount.rb +5 -5
  80. data/lib/orb/resources/alerts.rb +15 -15
  81. data/lib/orb/resources/coupons/subscriptions.rb +1 -1
  82. data/lib/orb/resources/coupons.rb +5 -5
  83. data/lib/orb/resources/credit_notes.rb +5 -5
  84. data/lib/orb/resources/customers/balance_transactions.rb +1 -1
  85. data/lib/orb/resources/customers/costs.rb +2 -2
  86. data/lib/orb/resources/customers/credits/ledger.rb +10 -10
  87. data/lib/orb/resources/customers/credits/top_ups.rb +4 -4
  88. data/lib/orb/resources/customers.rb +30 -30
  89. data/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rb +1 -1
  90. data/lib/orb/resources/dimensional_price_groups.rb +3 -3
  91. data/lib/orb/resources/events/volume.rb +1 -1
  92. data/lib/orb/resources/events.rb +1 -1
  93. data/lib/orb/resources/invoices.rb +12 -12
  94. data/lib/orb/resources/items.rb +5 -5
  95. data/lib/orb/resources/metrics.rb +4 -4
  96. data/lib/orb/resources/plans/external_plan_id.rb +2 -2
  97. data/lib/orb/resources/plans.rb +7 -7
  98. data/lib/orb/resources/prices/external_price_id.rb +2 -2
  99. data/lib/orb/resources/prices.rb +17 -17
  100. data/lib/orb/resources/subscriptions.rb +32 -32
  101. data/lib/orb/version.rb +1 -1
  102. data/rbi/orb/internal.rbi +3 -0
  103. data/rbi/orb/models/subscription_price_intervals_params.rbi +26 -72
  104. data/rbi/orb/models/subscription_update_trial_params.rbi +14 -3
  105. data/rbi/orb/resources/subscriptions.rbi +4 -1
  106. data/sig/orb/internal/page.rbs +2 -0
  107. data/sig/orb/internal.rbs +2 -0
  108. data/sig/orb/models/alert.rbs +32 -4
  109. data/sig/orb/models/alert_create_for_customer_params.rbs +9 -0
  110. data/sig/orb/models/alert_create_for_external_customer_params.rbs +9 -0
  111. data/sig/orb/models/alert_create_for_subscription_params.rbs +9 -0
  112. data/sig/orb/models/alert_disable_params.rbs +5 -0
  113. data/sig/orb/models/alert_enable_params.rbs +5 -0
  114. data/sig/orb/models/alert_list_params.rbs +13 -0
  115. data/sig/orb/models/alert_retrieve_params.rbs +2 -0
  116. data/sig/orb/models/alert_update_params.rbs +7 -0
  117. data/sig/orb/models/amount_discount.rbs +11 -4
  118. data/sig/orb/models/billable_metric.rbs +13 -4
  119. data/sig/orb/models/coupon.rbs +14 -4
  120. data/sig/orb/models/coupon_archive_params.rbs +2 -0
  121. data/sig/orb/models/coupon_create_params.rbs +15 -0
  122. data/sig/orb/models/coupon_fetch_params.rbs +2 -0
  123. data/sig/orb/models/coupon_list_params.rbs +8 -0
  124. data/sig/orb/models/coupons/subscription_list_params.rbs +6 -0
  125. data/sig/orb/models/credit_note.rbs +88 -20
  126. data/sig/orb/models/credit_note_create_params.rbs +9 -0
  127. data/sig/orb/models/credit_note_fetch_params.rbs +2 -0
  128. data/sig/orb/models/credit_note_list_params.rbs +10 -0
  129. data/sig/orb/models/customer.rbs +86 -16
  130. data/sig/orb/models/customer_create_params.rbs +79 -8
  131. data/sig/orb/models/customer_delete_params.rbs +2 -0
  132. data/sig/orb/models/customer_fetch_by_external_id_params.rbs +2 -0
  133. data/sig/orb/models/customer_fetch_params.rbs +2 -0
  134. data/sig/orb/models/customer_list_params.rbs +10 -0
  135. data/sig/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbs +2 -0
  136. data/sig/orb/models/customer_sync_payment_methods_from_gateway_params.rbs +2 -0
  137. data/sig/orb/models/customer_update_by_external_id_params.rbs +78 -8
  138. data/sig/orb/models/customer_update_params.rbs +78 -8
  139. data/sig/orb/models/customers/balance_transaction_create_params.rbs +7 -0
  140. data/sig/orb/models/customers/balance_transaction_create_response.rbs +17 -0
  141. data/sig/orb/models/customers/balance_transaction_list_params.rbs +10 -0
  142. data/sig/orb/models/customers/balance_transaction_list_response.rbs +17 -0
  143. data/sig/orb/models/customers/cost_list_by_external_id_params.rbs +8 -0
  144. data/sig/orb/models/customers/cost_list_by_external_id_response.rbs +20 -0
  145. data/sig/orb/models/customers/cost_list_params.rbs +8 -0
  146. data/sig/orb/models/customers/cost_list_response.rbs +20 -0
  147. data/sig/orb/models/customers/credit_list_by_external_id_params.rbs +8 -0
  148. data/sig/orb/models/customers/credit_list_by_external_id_response.rbs +10 -0
  149. data/sig/orb/models/customers/credit_list_params.rbs +8 -0
  150. data/sig/orb/models/customers/credit_list_response.rbs +10 -0
  151. data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbs +23 -0
  152. data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +177 -0
  153. data/sig/orb/models/customers/credits/ledger_create_entry_params.rbs +23 -0
  154. data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +177 -0
  155. data/sig/orb/models/customers/credits/ledger_list_by_external_id_params.rbs +14 -0
  156. data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +177 -0
  157. data/sig/orb/models/customers/credits/ledger_list_params.rbs +14 -0
  158. data/sig/orb/models/customers/credits/ledger_list_response.rbs +177 -0
  159. data/sig/orb/models/customers/credits/top_up_create_by_external_id_params.rbs +19 -0
  160. data/sig/orb/models/customers/credits/top_up_create_by_external_id_response.rbs +18 -0
  161. data/sig/orb/models/customers/credits/top_up_create_params.rbs +19 -0
  162. data/sig/orb/models/customers/credits/top_up_create_response.rbs +18 -0
  163. data/sig/orb/models/customers/credits/top_up_delete_by_external_id_params.rbs +5 -0
  164. data/sig/orb/models/customers/credits/top_up_delete_params.rbs +5 -0
  165. data/sig/orb/models/customers/credits/top_up_list_by_external_id_params.rbs +6 -0
  166. data/sig/orb/models/customers/credits/top_up_list_by_external_id_response.rbs +18 -0
  167. data/sig/orb/models/customers/credits/top_up_list_params.rbs +6 -0
  168. data/sig/orb/models/customers/credits/top_up_list_response.rbs +18 -0
  169. data/sig/orb/models/dimensional_price_group.rbs +9 -0
  170. data/sig/orb/models/dimensional_price_group_create_params.rbs +9 -0
  171. data/sig/orb/models/dimensional_price_group_list_params.rbs +6 -0
  172. data/sig/orb/models/dimensional_price_group_retrieve_params.rbs +2 -0
  173. data/sig/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbs +2 -0
  174. data/sig/orb/models/dimensional_price_groups.rbs +5 -0
  175. data/sig/orb/models/evaluate_price_group.rbs +10 -4
  176. data/sig/orb/models/event_deprecate_params.rbs +2 -0
  177. data/sig/orb/models/event_deprecate_response.rbs +2 -0
  178. data/sig/orb/models/event_ingest_params.rbs +16 -0
  179. data/sig/orb/models/event_ingest_response.rbs +15 -0
  180. data/sig/orb/models/event_search_params.rbs +7 -0
  181. data/sig/orb/models/event_search_response.rbs +12 -0
  182. data/sig/orb/models/event_update_params.rbs +9 -0
  183. data/sig/orb/models/event_update_response.rbs +2 -0
  184. data/sig/orb/models/events/backfill_close_params.rbs +2 -0
  185. data/sig/orb/models/events/backfill_close_response.rbs +14 -0
  186. data/sig/orb/models/events/backfill_create_params.rbs +11 -0
  187. data/sig/orb/models/events/backfill_create_response.rbs +14 -0
  188. data/sig/orb/models/events/backfill_fetch_params.rbs +2 -0
  189. data/sig/orb/models/events/backfill_fetch_response.rbs +14 -0
  190. data/sig/orb/models/events/backfill_list_params.rbs +6 -0
  191. data/sig/orb/models/events/backfill_list_response.rbs +14 -0
  192. data/sig/orb/models/events/backfill_revert_params.rbs +2 -0
  193. data/sig/orb/models/events/backfill_revert_response.rbs +14 -0
  194. data/sig/orb/models/events/event_volumes.rbs +8 -0
  195. data/sig/orb/models/events/volume_list_params.rbs +8 -0
  196. data/sig/orb/models/invoice.rbs +293 -36
  197. data/sig/orb/models/invoice_create_params.rbs +30 -4
  198. data/sig/orb/models/invoice_fetch_params.rbs +2 -0
  199. data/sig/orb/models/invoice_fetch_upcoming_params.rbs +5 -0
  200. data/sig/orb/models/invoice_fetch_upcoming_response.rbs +257 -0
  201. data/sig/orb/models/invoice_issue_params.rbs +5 -0
  202. data/sig/orb/models/invoice_line_item_create_params.rbs +10 -0
  203. data/sig/orb/models/invoice_line_item_create_response.rbs +132 -0
  204. data/sig/orb/models/invoice_list_params.rbs +27 -4
  205. data/sig/orb/models/invoice_mark_paid_params.rbs +7 -0
  206. data/sig/orb/models/invoice_pay_params.rbs +2 -0
  207. data/sig/orb/models/invoice_update_params.rbs +5 -0
  208. data/sig/orb/models/invoice_void_params.rbs +2 -0
  209. data/sig/orb/models/item.rbs +16 -4
  210. data/sig/orb/models/item_create_params.rbs +2 -0
  211. data/sig/orb/models/item_fetch_params.rbs +2 -0
  212. data/sig/orb/models/item_list_params.rbs +6 -0
  213. data/sig/orb/models/item_update_params.rbs +15 -4
  214. data/sig/orb/models/metric_create_params.rbs +9 -0
  215. data/sig/orb/models/metric_fetch_params.rbs +2 -0
  216. data/sig/orb/models/metric_list_params.rbs +10 -0
  217. data/sig/orb/models/metric_update_params.rbs +5 -0
  218. data/sig/orb/models/pagination_metadata.rbs +2 -0
  219. data/sig/orb/models/percentage_discount.rbs +11 -4
  220. data/sig/orb/models/plan.rbs +141 -16
  221. data/sig/orb/models/plan_create_params.rbs +1070 -304
  222. data/sig/orb/models/plan_fetch_params.rbs +2 -0
  223. data/sig/orb/models/plan_list_params.rbs +11 -0
  224. data/sig/orb/models/plan_update_params.rbs +6 -0
  225. data/sig/orb/models/plans/external_plan_id_fetch_params.rbs +2 -0
  226. data/sig/orb/models/plans/external_plan_id_update_params.rbs +6 -0
  227. data/sig/orb/models/price.rbs +2148 -460
  228. data/sig/orb/models/price_create_params.rbs +130 -8
  229. data/sig/orb/models/price_evaluate_params.rbs +10 -0
  230. data/sig/orb/models/price_evaluate_response.rbs +2 -0
  231. data/sig/orb/models/price_fetch_params.rbs +2 -0
  232. data/sig/orb/models/price_list_params.rbs +6 -0
  233. data/sig/orb/models/price_update_params.rbs +5 -0
  234. data/sig/orb/models/prices/external_price_id_fetch_params.rbs +2 -0
  235. data/sig/orb/models/prices/external_price_id_update_params.rbs +5 -0
  236. data/sig/orb/models/subscription.rbs +177 -12
  237. data/sig/orb/models/subscription_cancel_params.rbs +7 -0
  238. data/sig/orb/models/subscription_cancel_response.rbs +173 -0
  239. data/sig/orb/models/subscription_change_apply_params.rbs +6 -0
  240. data/sig/orb/models/subscription_change_apply_response.rbs +186 -0
  241. data/sig/orb/models/subscription_change_cancel_params.rbs +2 -0
  242. data/sig/orb/models/subscription_change_cancel_response.rbs +186 -0
  243. data/sig/orb/models/subscription_change_retrieve_params.rbs +2 -0
  244. data/sig/orb/models/subscription_change_retrieve_response.rbs +186 -0
  245. data/sig/orb/models/subscription_create_params.rbs +2368 -632
  246. data/sig/orb/models/subscription_create_response.rbs +173 -0
  247. data/sig/orb/models/subscription_fetch_costs_params.rbs +8 -0
  248. data/sig/orb/models/subscription_fetch_costs_response.rbs +20 -0
  249. data/sig/orb/models/subscription_fetch_params.rbs +2 -0
  250. data/sig/orb/models/subscription_fetch_schedule_params.rbs +10 -0
  251. data/sig/orb/models/subscription_fetch_schedule_response.rbs +13 -0
  252. data/sig/orb/models/subscription_fetch_usage_params.rbs +14 -0
  253. data/sig/orb/models/subscription_list_params.rbs +13 -0
  254. data/sig/orb/models/subscription_price_intervals_params.rbs +1348 -396
  255. data/sig/orb/models/subscription_price_intervals_response.rbs +173 -0
  256. data/sig/orb/models/subscription_schedule_plan_change_params.rbs +2363 -632
  257. data/sig/orb/models/subscription_schedule_plan_change_response.rbs +173 -0
  258. data/sig/orb/models/subscription_trigger_phase_params.rbs +6 -0
  259. data/sig/orb/models/subscription_trigger_phase_response.rbs +173 -0
  260. data/sig/orb/models/subscription_unschedule_cancellation_params.rbs +2 -0
  261. data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +173 -0
  262. data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbs +2 -0
  263. data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +173 -0
  264. data/sig/orb/models/subscription_unschedule_pending_plan_changes_params.rbs +2 -0
  265. data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +173 -0
  266. data/sig/orb/models/subscription_update_fixed_fee_quantity_params.rbs +9 -0
  267. data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +173 -0
  268. data/sig/orb/models/subscription_update_params.rbs +9 -0
  269. data/sig/orb/models/subscription_update_trial_params.rbs +6 -0
  270. data/sig/orb/models/subscription_update_trial_response.rbs +173 -0
  271. data/sig/orb/models/subscription_usage.rbs +48 -8
  272. data/sig/orb/models/subscriptions.rbs +5 -0
  273. data/sig/orb/models/top_level_ping_params.rbs +2 -0
  274. data/sig/orb/models/top_level_ping_response.rbs +2 -0
  275. data/sig/orb/models/trial_discount.rbs +12 -4
  276. data/sig/orb/models/usage_discount.rbs +11 -4
  277. data/sig/orb/resources/invoices.rbs +1 -1
  278. data/sig/orb/resources/plans.rbs +1 -1
  279. metadata +2 -2
@@ -146,11 +146,7 @@ module Orb
146
146
 
147
147
  # The start date of the price interval. This is the date that the price will start
148
148
  # billing on the subscription.
149
- sig do
150
- returns(
151
- Orb::SubscriptionPriceIntervalsParams::Add::StartDate::Variants
152
- )
153
- end
149
+ sig { returns(T.any(Time, Orb::BillingCycleRelativeDate::OrSymbol)) }
154
150
  attr_accessor :start_date
155
151
 
156
152
  # The definition of a new allocation price to create and add to the subscription.
@@ -193,9 +189,7 @@ module Orb
193
189
  # billing on the subscription.
194
190
  sig do
195
191
  returns(
196
- T.nilable(
197
- Orb::SubscriptionPriceIntervalsParams::Add::EndDate::Variants
198
- )
192
+ T.nilable(T.any(Time, Orb::BillingCycleRelativeDate::OrSymbol))
199
193
  )
200
194
  end
201
195
  attr_accessor :end_date
@@ -287,8 +281,7 @@ module Orb
287
281
 
288
282
  sig do
289
283
  params(
290
- start_date:
291
- Orb::SubscriptionPriceIntervalsParams::Add::StartDate::Variants,
284
+ start_date: T.any(Time, Orb::BillingCycleRelativeDate::OrSymbol),
292
285
  allocation_price:
293
286
  T.nilable(
294
287
  Orb::SubscriptionPriceIntervalsParams::Add::AllocationPrice::OrHash
@@ -304,9 +297,7 @@ module Orb
304
297
  ]
305
298
  ),
306
299
  end_date:
307
- T.nilable(
308
- Orb::SubscriptionPriceIntervalsParams::Add::EndDate::Variants
309
- ),
300
+ T.nilable(T.any(Time, Orb::BillingCycleRelativeDate::OrSymbol)),
310
301
  external_price_id: T.nilable(String),
311
302
  filter: T.nilable(String),
312
303
  fixed_fee_quantity_transitions:
@@ -397,8 +388,7 @@ module Orb
397
388
  sig do
398
389
  override.returns(
399
390
  {
400
- start_date:
401
- Orb::SubscriptionPriceIntervalsParams::Add::StartDate::Variants,
391
+ start_date: T.any(Time, Orb::BillingCycleRelativeDate::OrSymbol),
402
392
  allocation_price:
403
393
  T.nilable(
404
394
  Orb::SubscriptionPriceIntervalsParams::Add::AllocationPrice
@@ -414,9 +404,7 @@ module Orb
414
404
  ]
415
405
  ),
416
406
  end_date:
417
- T.nilable(
418
- Orb::SubscriptionPriceIntervalsParams::Add::EndDate::Variants
419
- ),
407
+ T.nilable(T.any(Time, Orb::BillingCycleRelativeDate::OrSymbol)),
420
408
  external_price_id: T.nilable(String),
421
409
  filter: T.nilable(String),
422
410
  fixed_fee_quantity_transitions:
@@ -13896,11 +13884,7 @@ module Orb
13896
13884
  # will start affecting prices on the subscription. The adjustment will apply to
13897
13885
  # invoice dates that overlap with this `start_date`. This `start_date` is treated
13898
13886
  # as inclusive for in-advance prices, and exclusive for in-arrears prices.
13899
- sig do
13900
- returns(
13901
- Orb::SubscriptionPriceIntervalsParams::AddAdjustment::StartDate::Variants
13902
- )
13903
- end
13887
+ sig { returns(T.any(Time, Orb::BillingCycleRelativeDate::OrSymbol)) }
13904
13888
  attr_accessor :start_date
13905
13889
 
13906
13890
  # The end date of the adjustment interval. This is the date that the adjustment
@@ -13909,9 +13893,7 @@ module Orb
13909
13893
  # exclusive for in-advance prices, and inclusive for in-arrears prices.
13910
13894
  sig do
13911
13895
  returns(
13912
- T.nilable(
13913
- Orb::SubscriptionPriceIntervalsParams::AddAdjustment::EndDate::Variants
13914
- )
13896
+ T.nilable(T.any(Time, Orb::BillingCycleRelativeDate::OrSymbol))
13915
13897
  )
13916
13898
  end
13917
13899
  attr_accessor :end_date
@@ -13926,12 +13908,9 @@ module Orb
13926
13908
  Orb::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::Minimum::OrHash,
13927
13909
  Orb::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::Maximum::OrHash
13928
13910
  ),
13929
- start_date:
13930
- Orb::SubscriptionPriceIntervalsParams::AddAdjustment::StartDate::Variants,
13911
+ start_date: T.any(Time, Orb::BillingCycleRelativeDate::OrSymbol),
13931
13912
  end_date:
13932
- T.nilable(
13933
- Orb::SubscriptionPriceIntervalsParams::AddAdjustment::EndDate::Variants
13934
- )
13913
+ T.nilable(T.any(Time, Orb::BillingCycleRelativeDate::OrSymbol))
13935
13914
  ).returns(T.attached_class)
13936
13915
  end
13937
13916
  def self.new(
@@ -13961,12 +13940,9 @@ module Orb
13961
13940
  Orb::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::Minimum,
13962
13941
  Orb::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment::Maximum
13963
13942
  ),
13964
- start_date:
13965
- Orb::SubscriptionPriceIntervalsParams::AddAdjustment::StartDate::Variants,
13943
+ start_date: T.any(Time, Orb::BillingCycleRelativeDate::OrSymbol),
13966
13944
  end_date:
13967
- T.nilable(
13968
- Orb::SubscriptionPriceIntervalsParams::AddAdjustment::EndDate::Variants
13969
- )
13945
+ T.nilable(T.any(Time, Orb::BillingCycleRelativeDate::OrSymbol))
13970
13946
  }
13971
13947
  )
13972
13948
  end
@@ -14377,9 +14353,7 @@ module Orb
14377
14353
  # will not be updated.
14378
14354
  sig do
14379
14355
  returns(
14380
- T.nilable(
14381
- Orb::SubscriptionPriceIntervalsParams::Edit::EndDate::Variants
14382
- )
14356
+ T.nilable(T.any(Time, Orb::BillingCycleRelativeDate::OrSymbol))
14383
14357
  )
14384
14358
  end
14385
14359
  attr_accessor :end_date
@@ -14409,17 +14383,14 @@ module Orb
14409
14383
  # will not be updated.
14410
14384
  sig do
14411
14385
  returns(
14412
- T.nilable(
14413
- Orb::SubscriptionPriceIntervalsParams::Edit::StartDate::Variants
14414
- )
14386
+ T.nilable(T.any(Time, Orb::BillingCycleRelativeDate::OrSymbol))
14415
14387
  )
14416
14388
  end
14417
14389
  attr_reader :start_date
14418
14390
 
14419
14391
  sig do
14420
14392
  params(
14421
- start_date:
14422
- Orb::SubscriptionPriceIntervalsParams::Edit::StartDate::Variants
14393
+ start_date: T.any(Time, Orb::BillingCycleRelativeDate::OrSymbol)
14423
14394
  ).void
14424
14395
  end
14425
14396
  attr_writer :start_date
@@ -14438,9 +14409,7 @@ module Orb
14438
14409
  price_interval_id: String,
14439
14410
  billing_cycle_day: T.nilable(Integer),
14440
14411
  end_date:
14441
- T.nilable(
14442
- Orb::SubscriptionPriceIntervalsParams::Edit::EndDate::Variants
14443
- ),
14412
+ T.nilable(T.any(Time, Orb::BillingCycleRelativeDate::OrSymbol)),
14444
14413
  filter: T.nilable(String),
14445
14414
  fixed_fee_quantity_transitions:
14446
14415
  T.nilable(
@@ -14448,8 +14417,7 @@ module Orb
14448
14417
  Orb::SubscriptionPriceIntervalsParams::Edit::FixedFeeQuantityTransition::OrHash
14449
14418
  ]
14450
14419
  ),
14451
- start_date:
14452
- Orb::SubscriptionPriceIntervalsParams::Edit::StartDate::Variants,
14420
+ start_date: T.any(Time, Orb::BillingCycleRelativeDate::OrSymbol),
14453
14421
  usage_customer_ids: T.nilable(T::Array[String])
14454
14422
  ).returns(T.attached_class)
14455
14423
  end
@@ -14491,9 +14459,7 @@ module Orb
14491
14459
  price_interval_id: String,
14492
14460
  billing_cycle_day: T.nilable(Integer),
14493
14461
  end_date:
14494
- T.nilable(
14495
- Orb::SubscriptionPriceIntervalsParams::Edit::EndDate::Variants
14496
- ),
14462
+ T.nilable(T.any(Time, Orb::BillingCycleRelativeDate::OrSymbol)),
14497
14463
  filter: T.nilable(String),
14498
14464
  fixed_fee_quantity_transitions:
14499
14465
  T.nilable(
@@ -14501,8 +14467,7 @@ module Orb
14501
14467
  Orb::SubscriptionPriceIntervalsParams::Edit::FixedFeeQuantityTransition
14502
14468
  ]
14503
14469
  ),
14504
- start_date:
14505
- Orb::SubscriptionPriceIntervalsParams::Edit::StartDate::Variants,
14470
+ start_date: T.any(Time, Orb::BillingCycleRelativeDate::OrSymbol),
14506
14471
  usage_customer_ids: T.nilable(T::Array[String])
14507
14472
  }
14508
14473
  )
@@ -14605,9 +14570,7 @@ module Orb
14605
14570
  # date will not be updated.
14606
14571
  sig do
14607
14572
  returns(
14608
- T.nilable(
14609
- Orb::SubscriptionPriceIntervalsParams::EditAdjustment::EndDate::Variants
14610
- )
14573
+ T.nilable(T.any(Time, Orb::BillingCycleRelativeDate::OrSymbol))
14611
14574
  )
14612
14575
  end
14613
14576
  attr_accessor :end_date
@@ -14616,17 +14579,14 @@ module Orb
14616
14579
  # date will not be updated.
14617
14580
  sig do
14618
14581
  returns(
14619
- T.nilable(
14620
- Orb::SubscriptionPriceIntervalsParams::EditAdjustment::StartDate::Variants
14621
- )
14582
+ T.nilable(T.any(Time, Orb::BillingCycleRelativeDate::OrSymbol))
14622
14583
  )
14623
14584
  end
14624
14585
  attr_reader :start_date
14625
14586
 
14626
14587
  sig do
14627
14588
  params(
14628
- start_date:
14629
- Orb::SubscriptionPriceIntervalsParams::EditAdjustment::StartDate::Variants
14589
+ start_date: T.any(Time, Orb::BillingCycleRelativeDate::OrSymbol)
14630
14590
  ).void
14631
14591
  end
14632
14592
  attr_writer :start_date
@@ -14635,11 +14595,8 @@ module Orb
14635
14595
  params(
14636
14596
  adjustment_interval_id: String,
14637
14597
  end_date:
14638
- T.nilable(
14639
- Orb::SubscriptionPriceIntervalsParams::EditAdjustment::EndDate::Variants
14640
- ),
14641
- start_date:
14642
- Orb::SubscriptionPriceIntervalsParams::EditAdjustment::StartDate::Variants
14598
+ T.nilable(T.any(Time, Orb::BillingCycleRelativeDate::OrSymbol)),
14599
+ start_date: T.any(Time, Orb::BillingCycleRelativeDate::OrSymbol)
14643
14600
  ).returns(T.attached_class)
14644
14601
  end
14645
14602
  def self.new(
@@ -14659,11 +14616,8 @@ module Orb
14659
14616
  {
14660
14617
  adjustment_interval_id: String,
14661
14618
  end_date:
14662
- T.nilable(
14663
- Orb::SubscriptionPriceIntervalsParams::EditAdjustment::EndDate::Variants
14664
- ),
14665
- start_date:
14666
- Orb::SubscriptionPriceIntervalsParams::EditAdjustment::StartDate::Variants
14619
+ T.nilable(T.any(Time, Orb::BillingCycleRelativeDate::OrSymbol)),
14620
+ start_date: T.any(Time, Orb::BillingCycleRelativeDate::OrSymbol)
14667
14621
  }
14668
14622
  )
14669
14623
  end
@@ -14,7 +14,12 @@ module Orb
14
14
  # The new date that the trial should end, or the literal string `immediate` to end
15
15
  # the trial immediately.
16
16
  sig do
17
- returns(Orb::SubscriptionUpdateTrialParams::TrialEndDate::Variants)
17
+ returns(
18
+ T.any(
19
+ Time,
20
+ Orb::SubscriptionUpdateTrialParams::TrialEndDate::OrSymbol
21
+ )
22
+ )
18
23
  end
19
24
  attr_accessor :trial_end_date
20
25
 
@@ -29,7 +34,10 @@ module Orb
29
34
  sig do
30
35
  params(
31
36
  trial_end_date:
32
- Orb::SubscriptionUpdateTrialParams::TrialEndDate::Variants,
37
+ T.any(
38
+ Time,
39
+ Orb::SubscriptionUpdateTrialParams::TrialEndDate::OrSymbol
40
+ ),
33
41
  shift: T::Boolean,
34
42
  request_options: Orb::RequestOptions::OrHash
35
43
  ).returns(T.attached_class)
@@ -49,7 +57,10 @@ module Orb
49
57
  override.returns(
50
58
  {
51
59
  trial_end_date:
52
- Orb::SubscriptionUpdateTrialParams::TrialEndDate::Variants,
60
+ T.any(
61
+ Time,
62
+ Orb::SubscriptionUpdateTrialParams::TrialEndDate::OrSymbol
63
+ ),
53
64
  shift: T::Boolean,
54
65
  request_options: Orb::RequestOptions
55
66
  }
@@ -1479,7 +1479,10 @@ module Orb
1479
1479
  params(
1480
1480
  subscription_id: String,
1481
1481
  trial_end_date:
1482
- Orb::SubscriptionUpdateTrialParams::TrialEndDate::Variants,
1482
+ T.any(
1483
+ Time,
1484
+ Orb::SubscriptionUpdateTrialParams::TrialEndDate::OrSymbol
1485
+ ),
1483
1486
  shift: T::Boolean,
1484
1487
  request_options: Orb::RequestOptions::OrHash
1485
1488
  ).returns(Orb::Models::SubscriptionUpdateTrialResponse)
@@ -16,6 +16,8 @@ module Orb
16
16
  attr_accessor next_cursor: String?
17
17
 
18
18
  def initialize: (has_more: bool, next_cursor: String?) -> void
19
+
20
+ def to_hash: -> { has_more: bool, next_cursor: String? }
19
21
  end
20
22
  end
21
23
  end
data/sig/orb/internal.rbs CHANGED
@@ -2,6 +2,8 @@ module Orb
2
2
  module Internal
3
3
  extend Orb::Internal::Util::SorbetRuntimeSupport
4
4
 
5
+ type file_input = Pathname | StringIO | IO | String | Orb::FilePart
6
+
5
7
  OMIT: Object
6
8
  end
7
9
  end
@@ -11,7 +11,7 @@ module Orb
11
11
  plan: Orb::Alert::Plan?,
12
12
  subscription: Orb::Alert::Subscription?,
13
13
  thresholds: ::Array[Orb::Alert::Threshold]?,
14
- type: Orb::Alert::type_
14
+ type: Orb::Models::Alert::type_
15
15
  }
16
16
 
17
17
  class Alert < Orb::Internal::Type::BaseModel
@@ -33,7 +33,7 @@ module Orb
33
33
 
34
34
  attr_accessor thresholds: ::Array[Orb::Alert::Threshold]?
35
35
 
36
- attr_accessor type: Orb::Alert::type_
36
+ attr_accessor type: Orb::Models::Alert::type_
37
37
 
38
38
  def initialize: (
39
39
  id: String,
@@ -45,9 +45,22 @@ module Orb
45
45
  plan: Orb::Alert::Plan?,
46
46
  subscription: Orb::Alert::Subscription?,
47
47
  thresholds: ::Array[Orb::Alert::Threshold]?,
48
- type: Orb::Alert::type_
48
+ type: Orb::Models::Alert::type_
49
49
  ) -> void
50
50
 
51
+ def to_hash: -> {
52
+ id: String,
53
+ created_at: Time,
54
+ currency: String?,
55
+ customer: Orb::Alert::Customer?,
56
+ enabled: bool,
57
+ metric: Orb::Alert::Metric?,
58
+ plan: Orb::Alert::Plan?,
59
+ subscription: Orb::Alert::Subscription?,
60
+ thresholds: ::Array[Orb::Alert::Threshold]?,
61
+ type: Orb::Models::Alert::type_
62
+ }
63
+
51
64
  type customer = { id: String, external_customer_id: String? }
52
65
 
53
66
  class Customer < Orb::Internal::Type::BaseModel
@@ -56,6 +69,8 @@ module Orb
56
69
  attr_accessor external_customer_id: String?
57
70
 
58
71
  def initialize: (id: String, external_customer_id: String?) -> void
72
+
73
+ def to_hash: -> { id: String, external_customer_id: String? }
59
74
  end
60
75
 
61
76
  type metric = { id: String }
@@ -64,6 +79,8 @@ module Orb
64
79
  attr_accessor id: String
65
80
 
66
81
  def initialize: (id: String) -> void
82
+
83
+ def to_hash: -> { id: String }
67
84
  end
68
85
 
69
86
  type plan =
@@ -89,6 +106,13 @@ module Orb
89
106
  name: String?,
90
107
  plan_version: String
91
108
  ) -> void
109
+
110
+ def to_hash: -> {
111
+ id: String?,
112
+ external_plan_id: String?,
113
+ name: String?,
114
+ plan_version: String
115
+ }
92
116
  end
93
117
 
94
118
  type subscription = { id: String }
@@ -97,6 +121,8 @@ module Orb
97
121
  attr_accessor id: String
98
122
 
99
123
  def initialize: (id: String) -> void
124
+
125
+ def to_hash: -> { id: String }
100
126
  end
101
127
 
102
128
  type threshold = { value: Float }
@@ -105,6 +131,8 @@ module Orb
105
131
  attr_accessor value: Float
106
132
 
107
133
  def initialize: (value: Float) -> void
134
+
135
+ def to_hash: -> { value: Float }
108
136
  end
109
137
 
110
138
  type type_ =
@@ -123,7 +151,7 @@ module Orb
123
151
  USAGE_EXCEEDED: :usage_exceeded
124
152
  COST_EXCEEDED: :cost_exceeded
125
153
 
126
- def self?.values: -> ::Array[Orb::Alert::type_]
154
+ def self?.values: -> ::Array[Orb::Models::Alert::type_]
127
155
  end
128
156
  end
129
157
  end
@@ -25,6 +25,13 @@ module Orb
25
25
  ?request_options: Orb::request_opts
26
26
  ) -> void
27
27
 
28
+ def to_hash: -> {
29
+ currency: String,
30
+ type: Orb::Models::AlertCreateForCustomerParams::type_,
31
+ thresholds: ::Array[Orb::AlertCreateForCustomerParams::Threshold]?,
32
+ request_options: Orb::RequestOptions
33
+ }
34
+
28
35
  type type_ =
29
36
  :credit_balance_depleted
30
37
  | :credit_balance_dropped
@@ -46,6 +53,8 @@ module Orb
46
53
  attr_accessor value: Float
47
54
 
48
55
  def initialize: (value: Float) -> void
56
+
57
+ def to_hash: -> { value: Float }
49
58
  end
50
59
  end
51
60
  end
@@ -25,6 +25,13 @@ module Orb
25
25
  ?request_options: Orb::request_opts
26
26
  ) -> void
27
27
 
28
+ def to_hash: -> {
29
+ currency: String,
30
+ type: Orb::Models::AlertCreateForExternalCustomerParams::type_,
31
+ thresholds: ::Array[Orb::AlertCreateForExternalCustomerParams::Threshold]?,
32
+ request_options: Orb::RequestOptions
33
+ }
34
+
28
35
  type type_ =
29
36
  :credit_balance_depleted
30
37
  | :credit_balance_dropped
@@ -46,6 +53,8 @@ module Orb
46
53
  attr_accessor value: Float
47
54
 
48
55
  def initialize: (value: Float) -> void
56
+
57
+ def to_hash: -> { value: Float }
49
58
  end
50
59
  end
51
60
  end
@@ -25,12 +25,21 @@ module Orb
25
25
  ?request_options: Orb::request_opts
26
26
  ) -> void
27
27
 
28
+ def to_hash: -> {
29
+ thresholds: ::Array[Orb::AlertCreateForSubscriptionParams::Threshold],
30
+ type: Orb::Models::AlertCreateForSubscriptionParams::type_,
31
+ metric_id: String?,
32
+ request_options: Orb::RequestOptions
33
+ }
34
+
28
35
  type threshold = { value: Float }
29
36
 
30
37
  class Threshold < Orb::Internal::Type::BaseModel
31
38
  attr_accessor value: Float
32
39
 
33
40
  def initialize: (value: Float) -> void
41
+
42
+ def to_hash: -> { value: Float }
34
43
  end
35
44
 
36
45
  type type_ = :usage_exceeded | :cost_exceeded
@@ -13,6 +13,11 @@ module Orb
13
13
  ?subscription_id: String?,
14
14
  ?request_options: Orb::request_opts
15
15
  ) -> void
16
+
17
+ def to_hash: -> {
18
+ subscription_id: String?,
19
+ request_options: Orb::RequestOptions
20
+ }
16
21
  end
17
22
  end
18
23
  end
@@ -13,6 +13,11 @@ module Orb
13
13
  ?subscription_id: String?,
14
14
  ?request_options: Orb::request_opts
15
15
  ) -> void
16
+
17
+ def to_hash: -> {
18
+ subscription_id: String?,
19
+ request_options: Orb::RequestOptions
20
+ }
16
21
  end
17
22
  end
18
23
  end
@@ -50,6 +50,19 @@ module Orb
50
50
  ?subscription_id: String?,
51
51
  ?request_options: Orb::request_opts
52
52
  ) -> void
53
+
54
+ def to_hash: -> {
55
+ created_at_gt: Time?,
56
+ created_at_gte: Time?,
57
+ created_at_lt: Time?,
58
+ created_at_lte: Time?,
59
+ cursor: String?,
60
+ customer_id: String?,
61
+ external_customer_id: String?,
62
+ limit: Integer,
63
+ subscription_id: String?,
64
+ request_options: Orb::RequestOptions
65
+ }
53
66
  end
54
67
  end
55
68
  end
@@ -7,6 +7,8 @@ module Orb
7
7
  include Orb::Internal::Type::RequestParameters
8
8
 
9
9
  def initialize: (?request_options: Orb::request_opts) -> void
10
+
11
+ def to_hash: -> { request_options: Orb::RequestOptions }
10
12
  end
11
13
  end
12
14
  end
@@ -15,12 +15,19 @@ module Orb
15
15
  ?request_options: Orb::request_opts
16
16
  ) -> void
17
17
 
18
+ def to_hash: -> {
19
+ thresholds: ::Array[Orb::AlertUpdateParams::Threshold],
20
+ request_options: Orb::RequestOptions
21
+ }
22
+
18
23
  type threshold = { value: Float }
19
24
 
20
25
  class Threshold < Orb::Internal::Type::BaseModel
21
26
  attr_accessor value: Float
22
27
 
23
28
  def initialize: (value: Float) -> void
29
+
30
+ def to_hash: -> { value: Float }
24
31
  end
25
32
  end
26
33
  end
@@ -4,7 +4,7 @@ module Orb
4
4
  {
5
5
  amount_discount: String,
6
6
  applies_to_price_ids: ::Array[String],
7
- discount_type: Orb::AmountDiscount::discount_type,
7
+ discount_type: Orb::Models::AmountDiscount::discount_type,
8
8
  reason: String?
9
9
  }
10
10
 
@@ -13,17 +13,24 @@ module Orb
13
13
 
14
14
  attr_accessor applies_to_price_ids: ::Array[String]
15
15
 
16
- attr_accessor discount_type: Orb::AmountDiscount::discount_type
16
+ attr_accessor discount_type: Orb::Models::AmountDiscount::discount_type
17
17
 
18
18
  attr_accessor reason: String?
19
19
 
20
20
  def initialize: (
21
21
  amount_discount: String,
22
22
  applies_to_price_ids: ::Array[String],
23
- discount_type: Orb::AmountDiscount::discount_type,
23
+ discount_type: Orb::Models::AmountDiscount::discount_type,
24
24
  ?reason: String?
25
25
  ) -> void
26
26
 
27
+ def to_hash: -> {
28
+ amount_discount: String,
29
+ applies_to_price_ids: ::Array[String],
30
+ discount_type: Orb::Models::AmountDiscount::discount_type,
31
+ reason: String?
32
+ }
33
+
27
34
  type discount_type = :amount
28
35
 
29
36
  module DiscountType
@@ -31,7 +38,7 @@ module Orb
31
38
 
32
39
  AMOUNT: :amount
33
40
 
34
- def self?.values: -> ::Array[Orb::AmountDiscount::discount_type]
41
+ def self?.values: -> ::Array[Orb::Models::AmountDiscount::discount_type]
35
42
  end
36
43
  end
37
44
  end
@@ -7,7 +7,7 @@ module Orb
7
7
  item: Orb::Item,
8
8
  metadata: ::Hash[Symbol, String],
9
9
  name: String,
10
- status: Orb::BillableMetric::status
10
+ status: Orb::Models::BillableMetric::status
11
11
  }
12
12
 
13
13
  class BillableMetric < Orb::Internal::Type::BaseModel
@@ -21,7 +21,7 @@ module Orb
21
21
 
22
22
  attr_accessor name: String
23
23
 
24
- attr_accessor status: Orb::BillableMetric::status
24
+ attr_accessor status: Orb::Models::BillableMetric::status
25
25
 
26
26
  def initialize: (
27
27
  id: String,
@@ -29,9 +29,18 @@ module Orb
29
29
  item: Orb::Item,
30
30
  metadata: ::Hash[Symbol, String],
31
31
  name: String,
32
- status: Orb::BillableMetric::status
32
+ status: Orb::Models::BillableMetric::status
33
33
  ) -> void
34
34
 
35
+ def to_hash: -> {
36
+ id: String,
37
+ description: String?,
38
+ item: Orb::Item,
39
+ metadata: ::Hash[Symbol, String],
40
+ name: String,
41
+ status: Orb::Models::BillableMetric::status
42
+ }
43
+
35
44
  type status = :active | :draft | :archived
36
45
 
37
46
  module Status
@@ -41,7 +50,7 @@ module Orb
41
50
  DRAFT: :draft
42
51
  ARCHIVED: :archived
43
52
 
44
- def self?.values: -> ::Array[Orb::BillableMetric::status]
53
+ def self?.values: -> ::Array[Orb::Models::BillableMetric::status]
45
54
  end
46
55
  end
47
56
  end