orb-billing 0.5.4 → 0.6.0

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 (211) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +26 -0
  3. data/README.md +1 -1
  4. data/lib/orb/internal/type/base_model.rb +2 -2
  5. data/lib/orb/internal/type/union.rb +6 -6
  6. data/lib/orb/internal/util.rb +5 -1
  7. data/lib/orb/models/alert.rb +33 -1
  8. data/lib/orb/models/amount_discount.rb +10 -10
  9. data/lib/orb/models/credit_note_create_params.rb +9 -9
  10. data/lib/orb/models/customer_create_params.rb +21 -3
  11. data/lib/orb/models/customer_update_by_external_id_params.rb +21 -3
  12. data/lib/orb/models/customer_update_params.rb +21 -3
  13. data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +9 -1
  14. data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +9 -1
  15. data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +9 -1
  16. data/lib/orb/models/customers/credits/ledger_list_response.rb +9 -1
  17. data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +1 -1
  18. data/lib/orb/models/customers/credits/top_up_create_params.rb +1 -1
  19. data/lib/orb/models/invoice.rb +626 -9
  20. data/lib/orb/models/invoice_fetch_upcoming_response.rb +624 -9
  21. data/lib/orb/models/invoice_line_item_create_response.rb +486 -7
  22. data/lib/orb/models/item.rb +18 -1
  23. data/lib/orb/models/item_archive_params.rb +14 -0
  24. data/lib/orb/models/item_create_params.rb +14 -1
  25. data/lib/orb/models/item_update_params.rb +16 -1
  26. data/lib/orb/models/percentage_discount.rb +10 -10
  27. data/lib/orb/models/plan.rb +618 -9
  28. data/lib/orb/models/plan_create_params.rb +2066 -30
  29. data/lib/orb/models/plan_set_default_version_params.rb +22 -0
  30. data/lib/orb/models/plans/external_plan_id/version_create_params.rb +17948 -0
  31. data/lib/orb/models/plans/external_plan_id/version_create_response.rb +819 -0
  32. data/lib/orb/models/plans/external_plan_id/version_retrieve_params.rb +24 -0
  33. data/lib/orb/models/plans/external_plan_id/version_retrieve_response.rb +819 -0
  34. data/lib/orb/models/plans/external_plan_id_set_default_version_params.rb +24 -0
  35. data/lib/orb/models/plans/version_create_params.rb +17794 -0
  36. data/lib/orb/models/plans/version_create_response.rb +814 -0
  37. data/lib/orb/models/plans/version_retrieve_params.rb +22 -0
  38. data/lib/orb/models/plans/version_retrieve_response.rb +814 -0
  39. data/lib/orb/models/price.rb +4124 -70
  40. data/lib/orb/models/price_create_params.rb +45 -1
  41. data/lib/orb/models/price_evaluate_params.rb +8529 -21
  42. data/lib/orb/models/price_evaluate_response.rb +38 -3
  43. data/lib/orb/models/subscription.rb +730 -54
  44. data/lib/orb/models/subscription_cancel_response.rb +706 -54
  45. data/lib/orb/models/subscription_change_apply_response.rb +728 -54
  46. data/lib/orb/models/subscription_change_cancel_response.rb +728 -54
  47. data/lib/orb/models/subscription_change_retrieve_response.rb +728 -54
  48. data/lib/orb/models/subscription_create_params.rb +5992 -1698
  49. data/lib/orb/models/subscription_create_response.rb +706 -54
  50. data/lib/orb/models/subscription_fetch_schedule_response.rb +3 -3
  51. data/lib/orb/models/subscription_price_intervals_params.rb +1392 -76
  52. data/lib/orb/models/subscription_price_intervals_response.rb +712 -54
  53. data/lib/orb/models/subscription_schedule_plan_change_params.rb +6005 -1723
  54. data/lib/orb/models/subscription_schedule_plan_change_response.rb +716 -54
  55. data/lib/orb/models/subscription_trigger_phase_response.rb +708 -54
  56. data/lib/orb/models/subscription_unschedule_cancellation_response.rb +720 -54
  57. data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +728 -54
  58. data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +728 -54
  59. data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +1 -1
  60. data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +720 -54
  61. data/lib/orb/models/subscription_update_trial_response.rb +706 -54
  62. data/lib/orb/models/trial_discount.rb +10 -10
  63. data/lib/orb/models/usage_discount.rb +10 -10
  64. data/lib/orb/models.rb +4 -0
  65. data/lib/orb/resources/credit_notes.rb +3 -3
  66. data/lib/orb/resources/customers/balance_transactions.rb +0 -7
  67. data/lib/orb/resources/customers.rb +4 -7
  68. data/lib/orb/resources/dimensional_price_groups.rb +1 -1
  69. data/lib/orb/resources/items.rb +34 -2
  70. data/lib/orb/resources/plans/external_plan_id/versions.rb +88 -0
  71. data/lib/orb/resources/plans/external_plan_id.rb +32 -1
  72. data/lib/orb/resources/plans/versions.rb +86 -0
  73. data/lib/orb/resources/plans.rb +33 -2
  74. data/lib/orb/resources/prices.rb +23 -17
  75. data/lib/orb/resources/subscriptions.rb +5 -1
  76. data/lib/orb/version.rb +1 -1
  77. data/lib/orb.rb +16 -1
  78. data/rbi/orb/models/alert.rbi +50 -3
  79. data/rbi/orb/models/amount_discount.rbi +8 -8
  80. data/rbi/orb/models/credit_note_create_params.rbi +8 -8
  81. data/rbi/orb/models/customer_create_params.rbi +38 -4
  82. data/rbi/orb/models/customer_update_by_external_id_params.rbi +38 -4
  83. data/rbi/orb/models/customer_update_params.rbi +38 -4
  84. data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +9 -1
  85. data/rbi/orb/models/customers/credits/ledger_create_entry_response.rbi +9 -1
  86. data/rbi/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +9 -1
  87. data/rbi/orb/models/customers/credits/ledger_list_response.rbi +9 -1
  88. data/rbi/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +2 -2
  89. data/rbi/orb/models/customers/credits/top_up_create_params.rbi +2 -2
  90. data/rbi/orb/models/invoice.rbi +1451 -35
  91. data/rbi/orb/models/invoice_fetch_upcoming_response.rbi +1524 -4
  92. data/rbi/orb/models/invoice_line_item_create_response.rbi +1184 -2
  93. data/rbi/orb/models/item.rbi +20 -1
  94. data/rbi/orb/models/item_archive_params.rbi +25 -0
  95. data/rbi/orb/models/item_create_params.rbi +18 -1
  96. data/rbi/orb/models/item_update_params.rbi +17 -1
  97. data/rbi/orb/models/percentage_discount.rbi +10 -10
  98. data/rbi/orb/models/plan.rbi +1339 -4
  99. data/rbi/orb/models/plan_create_params.rbi +3833 -29
  100. data/rbi/orb/models/plan_set_default_version_params.rbi +40 -0
  101. data/rbi/orb/models/plans/external_plan_id/version_create_params.rbi +32668 -0
  102. data/rbi/orb/models/plans/external_plan_id/version_create_response.rbi +1562 -0
  103. data/rbi/orb/models/plans/external_plan_id/version_retrieve_params.rbi +42 -0
  104. data/rbi/orb/models/plans/external_plan_id/version_retrieve_response.rbi +1562 -0
  105. data/rbi/orb/models/plans/external_plan_id_set_default_version_params.rbi +45 -0
  106. data/rbi/orb/models/plans/version_create_params.rbi +32607 -0
  107. data/rbi/orb/models/plans/version_create_response.rbi +1556 -0
  108. data/rbi/orb/models/plans/version_retrieve_params.rbi +37 -0
  109. data/rbi/orb/models/plans/version_retrieve_response.rbi +1558 -0
  110. data/rbi/orb/models/price.rbi +9447 -441
  111. data/rbi/orb/models/price_create_params.rbi +80 -0
  112. data/rbi/orb/models/price_evaluate_params.rbi +15684 -25
  113. data/rbi/orb/models/price_evaluate_response.rbi +68 -5
  114. data/rbi/orb/models/subscription.rbi +1654 -44
  115. data/rbi/orb/models/subscription_cancel_response.rbi +1692 -44
  116. data/rbi/orb/models/subscription_change_apply_response.rbi +1692 -44
  117. data/rbi/orb/models/subscription_change_cancel_response.rbi +1692 -44
  118. data/rbi/orb/models/subscription_change_retrieve_response.rbi +1692 -44
  119. data/rbi/orb/models/subscription_create_params.rbi +10400 -2710
  120. data/rbi/orb/models/subscription_create_response.rbi +1692 -44
  121. data/rbi/orb/models/subscription_fetch_schedule_response.rbi +13 -4
  122. data/rbi/orb/models/subscription_price_intervals_params.rbi +2401 -49
  123. data/rbi/orb/models/subscription_price_intervals_response.rbi +1692 -44
  124. data/rbi/orb/models/subscription_schedule_plan_change_params.rbi +10423 -2753
  125. data/rbi/orb/models/subscription_schedule_plan_change_response.rbi +1692 -44
  126. data/rbi/orb/models/subscription_trigger_phase_response.rbi +1692 -44
  127. data/rbi/orb/models/subscription_unschedule_cancellation_response.rbi +1692 -44
  128. data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +1692 -44
  129. data/rbi/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +1692 -44
  130. data/rbi/orb/models/subscription_update_fixed_fee_quantity_params.rbi +2 -2
  131. data/rbi/orb/models/subscription_update_fixed_fee_quantity_response.rbi +1692 -44
  132. data/rbi/orb/models/subscription_update_trial_response.rbi +1692 -44
  133. data/rbi/orb/models/trial_discount.rbi +8 -8
  134. data/rbi/orb/models/usage_discount.rbi +10 -10
  135. data/rbi/orb/models.rbi +4 -0
  136. data/rbi/orb/resources/credit_notes.rbi +3 -3
  137. data/rbi/orb/resources/customers/balance_transactions.rbi +0 -7
  138. data/rbi/orb/resources/customers/credits/top_ups.rbi +2 -2
  139. data/rbi/orb/resources/customers.rbi +7 -7
  140. data/rbi/orb/resources/dimensional_price_groups.rbi +1 -1
  141. data/rbi/orb/resources/items.rbi +20 -0
  142. data/rbi/orb/resources/plans/external_plan_id/versions.rbi +103 -0
  143. data/rbi/orb/resources/plans/external_plan_id.rbi +23 -1
  144. data/rbi/orb/resources/plans/versions.rbi +91 -0
  145. data/rbi/orb/resources/plans.rbi +27 -2
  146. data/rbi/orb/resources/prices.rbi +27 -17
  147. data/rbi/orb/resources/subscriptions.rbi +9 -1
  148. data/sig/orb/models/alert.rbs +20 -3
  149. data/sig/orb/models/amount_discount.rbs +5 -5
  150. data/sig/orb/models/credit_note_create_params.rbs +6 -6
  151. data/sig/orb/models/customer_create_params.rbs +13 -0
  152. data/sig/orb/models/customer_update_by_external_id_params.rbs +13 -0
  153. data/sig/orb/models/customer_update_params.rbs +13 -0
  154. data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +7 -2
  155. data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +7 -2
  156. data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +7 -2
  157. data/sig/orb/models/customers/credits/ledger_list_response.rbs +7 -2
  158. data/sig/orb/models/invoice.rbs +558 -4
  159. data/sig/orb/models/invoice_fetch_upcoming_response.rbs +558 -4
  160. data/sig/orb/models/invoice_line_item_create_response.rbs +414 -2
  161. data/sig/orb/models/item.rbs +5 -0
  162. data/sig/orb/models/item_archive_params.rbs +14 -0
  163. data/sig/orb/models/item_create_params.rbs +10 -2
  164. data/sig/orb/models/item_update_params.rbs +5 -0
  165. data/sig/orb/models/percentage_discount.rbs +5 -5
  166. data/sig/orb/models/plan.rbs +538 -4
  167. data/sig/orb/models/plan_create_params.rbs +1460 -3
  168. data/sig/orb/models/plan_set_default_version_params.rbs +20 -0
  169. data/sig/orb/models/plans/external_plan_id/version_create_params.rbs +12923 -0
  170. data/sig/orb/models/plans/external_plan_id/version_create_response.rbs +664 -0
  171. data/sig/orb/models/plans/external_plan_id/version_retrieve_params.rbs +27 -0
  172. data/sig/orb/models/plans/external_plan_id/version_retrieve_response.rbs +664 -0
  173. data/sig/orb/models/plans/external_plan_id_set_default_version_params.rbs +25 -0
  174. data/sig/orb/models/plans/version_create_params.rbs +12898 -0
  175. data/sig/orb/models/plans/version_create_response.rbs +662 -0
  176. data/sig/orb/models/plans/version_retrieve_params.rbs +25 -0
  177. data/sig/orb/models/plans/version_retrieve_response.rbs +662 -0
  178. data/sig/orb/models/price.rbs +3512 -96
  179. data/sig/orb/models/price_create_params.rbs +32 -0
  180. data/sig/orb/models/price_evaluate_params.rbs +6187 -10
  181. data/sig/orb/models/price_evaluate_response.rbs +41 -4
  182. data/sig/orb/models/subscription.rbs +609 -29
  183. data/sig/orb/models/subscription_cancel_response.rbs +609 -29
  184. data/sig/orb/models/subscription_change_apply_response.rbs +621 -29
  185. data/sig/orb/models/subscription_change_cancel_response.rbs +621 -29
  186. data/sig/orb/models/subscription_change_retrieve_response.rbs +621 -29
  187. data/sig/orb/models/subscription_create_params.rbs +4450 -1466
  188. data/sig/orb/models/subscription_create_response.rbs +609 -29
  189. data/sig/orb/models/subscription_fetch_schedule_response.rbs +4 -4
  190. data/sig/orb/models/subscription_price_intervals_params.rbs +920 -24
  191. data/sig/orb/models/subscription_price_intervals_response.rbs +609 -29
  192. data/sig/orb/models/subscription_schedule_plan_change_params.rbs +4440 -1466
  193. data/sig/orb/models/subscription_schedule_plan_change_response.rbs +609 -29
  194. data/sig/orb/models/subscription_trigger_phase_response.rbs +609 -29
  195. data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +609 -29
  196. data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +609 -29
  197. data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +609 -29
  198. data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +609 -29
  199. data/sig/orb/models/subscription_update_trial_response.rbs +609 -29
  200. data/sig/orb/models/trial_discount.rbs +5 -5
  201. data/sig/orb/models/usage_discount.rbs +5 -5
  202. data/sig/orb/models.rbs +4 -0
  203. data/sig/orb/resources/credit_notes.rbs +1 -1
  204. data/sig/orb/resources/items.rbs +7 -0
  205. data/sig/orb/resources/plans/external_plan_id/versions.rbs +30 -0
  206. data/sig/orb/resources/plans/external_plan_id.rbs +8 -0
  207. data/sig/orb/resources/plans/versions.rbs +28 -0
  208. data/sig/orb/resources/plans.rbs +8 -0
  209. data/sig/orb/resources/prices.rbs +3 -3
  210. data/sig/orb/resources/subscriptions.rbs +2 -0
  211. metadata +41 -2
@@ -2,18 +2,18 @@ module Orb
2
2
  module Models
3
3
  type trial_discount =
4
4
  {
5
- applies_to_price_ids: ::Array[String],
6
5
  discount_type: Orb::Models::TrialDiscount::discount_type,
6
+ applies_to_price_ids: ::Array[String]?,
7
7
  reason: String?,
8
8
  trial_amount_discount: String?,
9
9
  trial_percentage_discount: Float?
10
10
  }
11
11
 
12
12
  class TrialDiscount < Orb::Internal::Type::BaseModel
13
- attr_accessor applies_to_price_ids: ::Array[String]
14
-
15
13
  attr_accessor discount_type: Orb::Models::TrialDiscount::discount_type
16
14
 
15
+ attr_accessor applies_to_price_ids: ::Array[String]?
16
+
17
17
  attr_accessor reason: String?
18
18
 
19
19
  attr_accessor trial_amount_discount: String?
@@ -21,16 +21,16 @@ module Orb
21
21
  attr_accessor trial_percentage_discount: Float?
22
22
 
23
23
  def initialize: (
24
- applies_to_price_ids: ::Array[String],
25
24
  discount_type: Orb::Models::TrialDiscount::discount_type,
25
+ ?applies_to_price_ids: ::Array[String]?,
26
26
  ?reason: String?,
27
27
  ?trial_amount_discount: String?,
28
28
  ?trial_percentage_discount: Float?
29
29
  ) -> void
30
30
 
31
31
  def to_hash: -> {
32
- applies_to_price_ids: ::Array[String],
33
32
  discount_type: Orb::Models::TrialDiscount::discount_type,
33
+ applies_to_price_ids: ::Array[String]?,
34
34
  reason: String?,
35
35
  trial_amount_discount: String?,
36
36
  trial_percentage_discount: Float?
@@ -2,32 +2,32 @@ module Orb
2
2
  module Models
3
3
  type usage_discount =
4
4
  {
5
- applies_to_price_ids: ::Array[String],
6
5
  discount_type: Orb::Models::UsageDiscount::discount_type,
7
6
  usage_discount: Float,
7
+ applies_to_price_ids: ::Array[String]?,
8
8
  reason: String?
9
9
  }
10
10
 
11
11
  class UsageDiscount < Orb::Internal::Type::BaseModel
12
- attr_accessor applies_to_price_ids: ::Array[String]
13
-
14
12
  attr_accessor discount_type: Orb::Models::UsageDiscount::discount_type
15
13
 
16
14
  attr_accessor usage_discount: Float
17
15
 
16
+ attr_accessor applies_to_price_ids: ::Array[String]?
17
+
18
18
  attr_accessor reason: String?
19
19
 
20
20
  def initialize: (
21
- applies_to_price_ids: ::Array[String],
22
21
  discount_type: Orb::Models::UsageDiscount::discount_type,
23
22
  usage_discount: Float,
23
+ ?applies_to_price_ids: ::Array[String]?,
24
24
  ?reason: String?
25
25
  ) -> void
26
26
 
27
27
  def to_hash: -> {
28
- applies_to_price_ids: ::Array[String],
29
28
  discount_type: Orb::Models::UsageDiscount::discount_type,
30
29
  usage_discount: Float,
30
+ applies_to_price_ids: ::Array[String]?,
31
31
  reason: String?
32
32
  }
33
33
 
data/sig/orb/models.rbs CHANGED
@@ -117,6 +117,8 @@ module Orb
117
117
 
118
118
  class Item = Orb::Models::Item
119
119
 
120
+ class ItemArchiveParams = Orb::Models::ItemArchiveParams
121
+
120
122
  class ItemCreateParams = Orb::Models::ItemCreateParams
121
123
 
122
124
  class ItemFetchParams = Orb::Models::ItemFetchParams
@@ -147,6 +149,8 @@ module Orb
147
149
 
148
150
  module Plans = Orb::Models::Plans
149
151
 
152
+ class PlanSetDefaultVersionParams = Orb::Models::PlanSetDefaultVersionParams
153
+
150
154
  class PlanUpdateParams = Orb::Models::PlanUpdateParams
151
155
 
152
156
  module Price = Orb::Models::Price
@@ -3,8 +3,8 @@ module Orb
3
3
  class CreditNotes
4
4
  def create: (
5
5
  line_items: ::Array[Orb::CreditNoteCreateParams::LineItem],
6
+ reason: Orb::Models::CreditNoteCreateParams::reason,
6
7
  ?memo: String?,
7
- ?reason: Orb::Models::CreditNoteCreateParams::reason?,
8
8
  ?request_options: Orb::request_opts
9
9
  ) -> Orb::CreditNote
10
10
 
@@ -3,12 +3,14 @@ module Orb
3
3
  class Items
4
4
  def create: (
5
5
  name: String,
6
+ ?metadata: ::Hash[Symbol, String?]?,
6
7
  ?request_options: Orb::request_opts
7
8
  ) -> Orb::Item
8
9
 
9
10
  def update: (
10
11
  String item_id,
11
12
  ?external_connections: ::Array[Orb::ItemUpdateParams::ExternalConnection]?,
13
+ ?metadata: ::Hash[Symbol, String?]?,
12
14
  ?name: String?,
13
15
  ?request_options: Orb::request_opts
14
16
  ) -> Orb::Item
@@ -19,6 +21,11 @@ module Orb
19
21
  ?request_options: Orb::request_opts
20
22
  ) -> Orb::Internal::Page[Orb::Item]
21
23
 
24
+ def archive: (
25
+ String item_id,
26
+ ?request_options: Orb::request_opts
27
+ ) -> Orb::Item
28
+
22
29
  def fetch: (
23
30
  String item_id,
24
31
  ?request_options: Orb::request_opts
@@ -0,0 +1,30 @@
1
+ module Orb
2
+ module Resources
3
+ class Plans
4
+ class ExternalPlanID
5
+ class Versions
6
+ def create: (
7
+ String external_plan_id,
8
+ version: Integer,
9
+ ?add_adjustments: ::Array[Orb::Plans::ExternalPlanID::VersionCreateParams::AddAdjustment]?,
10
+ ?add_prices: ::Array[Orb::Plans::ExternalPlanID::VersionCreateParams::AddPrice]?,
11
+ ?remove_adjustments: ::Array[Orb::Plans::ExternalPlanID::VersionCreateParams::RemoveAdjustment]?,
12
+ ?remove_prices: ::Array[Orb::Plans::ExternalPlanID::VersionCreateParams::RemovePrice]?,
13
+ ?replace_adjustments: ::Array[Orb::Plans::ExternalPlanID::VersionCreateParams::ReplaceAdjustment]?,
14
+ ?replace_prices: ::Array[Orb::Plans::ExternalPlanID::VersionCreateParams::ReplacePrice]?,
15
+ ?set_as_default: bool?,
16
+ ?request_options: Orb::request_opts
17
+ ) -> Orb::Models::Plans::ExternalPlanID::VersionCreateResponse
18
+
19
+ def retrieve: (
20
+ String version,
21
+ external_plan_id: String,
22
+ ?request_options: Orb::request_opts
23
+ ) -> Orb::Models::Plans::ExternalPlanID::VersionRetrieveResponse
24
+
25
+ def initialize: (client: Orb::Client) -> void
26
+ end
27
+ end
28
+ end
29
+ end
30
+ end
@@ -2,6 +2,8 @@ module Orb
2
2
  module Resources
3
3
  class Plans
4
4
  class ExternalPlanID
5
+ attr_reader versions: Orb::Resources::Plans::ExternalPlanID::Versions
6
+
5
7
  def update: (
6
8
  String other_external_plan_id,
7
9
  ?external_plan_id: String?,
@@ -14,6 +16,12 @@ module Orb
14
16
  ?request_options: Orb::request_opts
15
17
  ) -> Orb::Plan
16
18
 
19
+ def set_default_version: (
20
+ String external_plan_id,
21
+ version: Integer,
22
+ ?request_options: Orb::request_opts
23
+ ) -> Orb::Plan
24
+
17
25
  def initialize: (client: Orb::Client) -> void
18
26
  end
19
27
  end
@@ -0,0 +1,28 @@
1
+ module Orb
2
+ module Resources
3
+ class Plans
4
+ class Versions
5
+ def create: (
6
+ String plan_id,
7
+ version: Integer,
8
+ ?add_adjustments: ::Array[Orb::Plans::VersionCreateParams::AddAdjustment]?,
9
+ ?add_prices: ::Array[Orb::Plans::VersionCreateParams::AddPrice]?,
10
+ ?remove_adjustments: ::Array[Orb::Plans::VersionCreateParams::RemoveAdjustment]?,
11
+ ?remove_prices: ::Array[Orb::Plans::VersionCreateParams::RemovePrice]?,
12
+ ?replace_adjustments: ::Array[Orb::Plans::VersionCreateParams::ReplaceAdjustment]?,
13
+ ?replace_prices: ::Array[Orb::Plans::VersionCreateParams::ReplacePrice]?,
14
+ ?set_as_default: bool?,
15
+ ?request_options: Orb::request_opts
16
+ ) -> Orb::Models::Plans::VersionCreateResponse
17
+
18
+ def retrieve: (
19
+ String version,
20
+ plan_id: String,
21
+ ?request_options: Orb::request_opts
22
+ ) -> Orb::Models::Plans::VersionRetrieveResponse
23
+
24
+ def initialize: (client: Orb::Client) -> void
25
+ end
26
+ end
27
+ end
28
+ end
@@ -3,6 +3,8 @@ module Orb
3
3
  class Plans
4
4
  attr_reader external_plan_id: Orb::Resources::Plans::ExternalPlanID
5
5
 
6
+ attr_reader versions: Orb::Resources::Plans::Versions
7
+
6
8
  def create: (
7
9
  currency: String,
8
10
  name: String,
@@ -38,6 +40,12 @@ module Orb
38
40
  ?request_options: Orb::request_opts
39
41
  ) -> Orb::Plan
40
42
 
43
+ def set_default_version: (
44
+ String plan_id,
45
+ version: Integer,
46
+ ?request_options: Orb::request_opts
47
+ ) -> Orb::Plan
48
+
41
49
  def initialize: (client: Orb::Client) -> void
42
50
  end
43
51
  end
@@ -41,6 +41,7 @@ module Orb
41
41
  ?billed_in_advance: bool?,
42
42
  ?billing_cycle_configuration: Orb::PriceCreateParams::BillingCycleConfiguration?,
43
43
  ?conversion_rate: Float?,
44
+ ?dimensional_price_configuration: Orb::PriceCreateParams::DimensionalPriceConfiguration?,
44
45
  ?external_price_id: String?,
45
46
  ?fixed_price_quantity: Float?,
46
47
  ?invoice_grouping_key: String?,
@@ -62,13 +63,12 @@ module Orb
62
63
  ) -> Orb::Internal::Page[Orb::Models::price]
63
64
 
64
65
  def evaluate: (
65
- String price_id,
66
66
  timeframe_end: Time,
67
67
  timeframe_start: Time,
68
68
  ?customer_id: String?,
69
+ ?events: ::Array[Orb::PriceEvaluateParams::Event]?,
69
70
  ?external_customer_id: String?,
70
- ?filter: String?,
71
- ?grouping_keys: ::Array[String],
71
+ ?price_evaluations: ::Array[Orb::PriceEvaluateParams::PriceEvaluation],
72
72
  ?request_options: Orb::request_opts
73
73
  ) -> Orb::Models::PriceEvaluateResponse
74
74
 
@@ -10,6 +10,7 @@ module Orb
10
10
  ?billing_cycle_anchor_configuration: Orb::SubscriptionCreateParams::BillingCycleAnchorConfiguration?,
11
11
  ?coupon_redemption_code: String?,
12
12
  ?credits_overage_rate: Float?,
13
+ ?currency: String?,
13
14
  ?customer_id: String?,
14
15
  ?default_invoice_memo: String?,
15
16
  ?end_date: Time?,
@@ -21,6 +22,7 @@ module Orb
21
22
  ?initial_phase_order: Integer?,
22
23
  ?invoicing_threshold: String?,
23
24
  ?metadata: ::Hash[Symbol, String?]?,
25
+ ?name: String?,
24
26
  ?net_terms: Integer?,
25
27
  ?per_credit_overage_amount: Float?,
26
28
  ?plan_id: String?,
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: orb-billing
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.5.4
4
+ version: 0.6.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Orb
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2025-05-23 00:00:00.000000000 Z
11
+ date: 2025-05-28 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: connection_pool
@@ -161,6 +161,7 @@ files:
161
161
  - lib/orb/models/invoice_update_params.rb
162
162
  - lib/orb/models/invoice_void_params.rb
163
163
  - lib/orb/models/item.rb
164
+ - lib/orb/models/item_archive_params.rb
164
165
  - lib/orb/models/item_create_params.rb
165
166
  - lib/orb/models/item_fetch_params.rb
166
167
  - lib/orb/models/item_list_params.rb
@@ -175,9 +176,19 @@ files:
175
176
  - lib/orb/models/plan_create_params.rb
176
177
  - lib/orb/models/plan_fetch_params.rb
177
178
  - lib/orb/models/plan_list_params.rb
179
+ - lib/orb/models/plan_set_default_version_params.rb
178
180
  - lib/orb/models/plan_update_params.rb
181
+ - lib/orb/models/plans/external_plan_id/version_create_params.rb
182
+ - lib/orb/models/plans/external_plan_id/version_create_response.rb
183
+ - lib/orb/models/plans/external_plan_id/version_retrieve_params.rb
184
+ - lib/orb/models/plans/external_plan_id/version_retrieve_response.rb
179
185
  - lib/orb/models/plans/external_plan_id_fetch_params.rb
186
+ - lib/orb/models/plans/external_plan_id_set_default_version_params.rb
180
187
  - lib/orb/models/plans/external_plan_id_update_params.rb
188
+ - lib/orb/models/plans/version_create_params.rb
189
+ - lib/orb/models/plans/version_create_response.rb
190
+ - lib/orb/models/plans/version_retrieve_params.rb
191
+ - lib/orb/models/plans/version_retrieve_response.rb
181
192
  - lib/orb/models/price.rb
182
193
  - lib/orb/models/price_create_params.rb
183
194
  - lib/orb/models/price_evaluate_params.rb
@@ -250,6 +261,8 @@ files:
250
261
  - lib/orb/resources/metrics.rb
251
262
  - lib/orb/resources/plans.rb
252
263
  - lib/orb/resources/plans/external_plan_id.rb
264
+ - lib/orb/resources/plans/external_plan_id/versions.rb
265
+ - lib/orb/resources/plans/versions.rb
253
266
  - lib/orb/resources/prices.rb
254
267
  - lib/orb/resources/prices/external_price_id.rb
255
268
  - lib/orb/resources/subscription_changes.rb
@@ -382,6 +395,7 @@ files:
382
395
  - rbi/orb/models/invoice_update_params.rbi
383
396
  - rbi/orb/models/invoice_void_params.rbi
384
397
  - rbi/orb/models/item.rbi
398
+ - rbi/orb/models/item_archive_params.rbi
385
399
  - rbi/orb/models/item_create_params.rbi
386
400
  - rbi/orb/models/item_fetch_params.rbi
387
401
  - rbi/orb/models/item_list_params.rbi
@@ -396,9 +410,19 @@ files:
396
410
  - rbi/orb/models/plan_create_params.rbi
397
411
  - rbi/orb/models/plan_fetch_params.rbi
398
412
  - rbi/orb/models/plan_list_params.rbi
413
+ - rbi/orb/models/plan_set_default_version_params.rbi
399
414
  - rbi/orb/models/plan_update_params.rbi
415
+ - rbi/orb/models/plans/external_plan_id/version_create_params.rbi
416
+ - rbi/orb/models/plans/external_plan_id/version_create_response.rbi
417
+ - rbi/orb/models/plans/external_plan_id/version_retrieve_params.rbi
418
+ - rbi/orb/models/plans/external_plan_id/version_retrieve_response.rbi
400
419
  - rbi/orb/models/plans/external_plan_id_fetch_params.rbi
420
+ - rbi/orb/models/plans/external_plan_id_set_default_version_params.rbi
401
421
  - rbi/orb/models/plans/external_plan_id_update_params.rbi
422
+ - rbi/orb/models/plans/version_create_params.rbi
423
+ - rbi/orb/models/plans/version_create_response.rbi
424
+ - rbi/orb/models/plans/version_retrieve_params.rbi
425
+ - rbi/orb/models/plans/version_retrieve_response.rbi
402
426
  - rbi/orb/models/price.rbi
403
427
  - rbi/orb/models/price_create_params.rbi
404
428
  - rbi/orb/models/price_evaluate_params.rbi
@@ -471,6 +495,8 @@ files:
471
495
  - rbi/orb/resources/metrics.rbi
472
496
  - rbi/orb/resources/plans.rbi
473
497
  - rbi/orb/resources/plans/external_plan_id.rbi
498
+ - rbi/orb/resources/plans/external_plan_id/versions.rbi
499
+ - rbi/orb/resources/plans/versions.rbi
474
500
  - rbi/orb/resources/prices.rbi
475
501
  - rbi/orb/resources/prices/external_price_id.rbi
476
502
  - rbi/orb/resources/subscription_changes.rbi
@@ -602,6 +628,7 @@ files:
602
628
  - sig/orb/models/invoice_update_params.rbs
603
629
  - sig/orb/models/invoice_void_params.rbs
604
630
  - sig/orb/models/item.rbs
631
+ - sig/orb/models/item_archive_params.rbs
605
632
  - sig/orb/models/item_create_params.rbs
606
633
  - sig/orb/models/item_fetch_params.rbs
607
634
  - sig/orb/models/item_list_params.rbs
@@ -616,9 +643,19 @@ files:
616
643
  - sig/orb/models/plan_create_params.rbs
617
644
  - sig/orb/models/plan_fetch_params.rbs
618
645
  - sig/orb/models/plan_list_params.rbs
646
+ - sig/orb/models/plan_set_default_version_params.rbs
619
647
  - sig/orb/models/plan_update_params.rbs
648
+ - sig/orb/models/plans/external_plan_id/version_create_params.rbs
649
+ - sig/orb/models/plans/external_plan_id/version_create_response.rbs
650
+ - sig/orb/models/plans/external_plan_id/version_retrieve_params.rbs
651
+ - sig/orb/models/plans/external_plan_id/version_retrieve_response.rbs
620
652
  - sig/orb/models/plans/external_plan_id_fetch_params.rbs
653
+ - sig/orb/models/plans/external_plan_id_set_default_version_params.rbs
621
654
  - sig/orb/models/plans/external_plan_id_update_params.rbs
655
+ - sig/orb/models/plans/version_create_params.rbs
656
+ - sig/orb/models/plans/version_create_response.rbs
657
+ - sig/orb/models/plans/version_retrieve_params.rbs
658
+ - sig/orb/models/plans/version_retrieve_response.rbs
622
659
  - sig/orb/models/price.rbs
623
660
  - sig/orb/models/price_create_params.rbs
624
661
  - sig/orb/models/price_evaluate_params.rbs
@@ -691,6 +728,8 @@ files:
691
728
  - sig/orb/resources/metrics.rbs
692
729
  - sig/orb/resources/plans.rbs
693
730
  - sig/orb/resources/plans/external_plan_id.rbs
731
+ - sig/orb/resources/plans/external_plan_id/versions.rbs
732
+ - sig/orb/resources/plans/versions.rbs
694
733
  - sig/orb/resources/prices.rbs
695
734
  - sig/orb/resources/prices/external_price_id.rbs
696
735
  - sig/orb/resources/subscription_changes.rbs