orb-billing 0.5.5 → 0.7.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 (205) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +26 -0
  3. data/README.md +1 -1
  4. data/lib/orb/client.rb +4 -0
  5. data/lib/orb/internal/type/base_model.rb +2 -2
  6. data/lib/orb/internal/type/union.rb +6 -6
  7. data/lib/orb/models/alert.rb +33 -1
  8. data/lib/orb/models/amount_discount.rb +10 -10
  9. data/lib/orb/models/beta/external_plan_id_create_plan_version_params.rb +17940 -0
  10. data/lib/orb/models/beta/external_plan_id_fetch_plan_version_params.rb +22 -0
  11. data/lib/orb/models/beta/external_plan_id_set_default_plan_version_params.rb +24 -0
  12. data/lib/orb/models/beta_create_plan_version_params.rb +17758 -0
  13. data/lib/orb/models/beta_fetch_plan_version_params.rb +20 -0
  14. data/lib/orb/models/beta_set_default_plan_version_params.rb +22 -0
  15. data/lib/orb/models/credit_note_create_params.rb +9 -9
  16. data/lib/orb/models/customer_create_params.rb +21 -3
  17. data/lib/orb/models/customer_update_by_external_id_params.rb +21 -3
  18. data/lib/orb/models/customer_update_params.rb +21 -3
  19. data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +9 -1
  20. data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +9 -1
  21. data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +9 -1
  22. data/lib/orb/models/customers/credits/ledger_list_response.rb +9 -1
  23. data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +1 -1
  24. data/lib/orb/models/customers/credits/top_up_create_params.rb +1 -1
  25. data/lib/orb/models/invoice.rb +626 -9
  26. data/lib/orb/models/invoice_fetch_upcoming_response.rb +624 -9
  27. data/lib/orb/models/invoice_line_item_create_response.rb +486 -7
  28. data/lib/orb/models/item.rb +18 -1
  29. data/lib/orb/models/item_archive_params.rb +14 -0
  30. data/lib/orb/models/item_create_params.rb +14 -1
  31. data/lib/orb/models/item_update_params.rb +16 -1
  32. data/lib/orb/models/percentage_discount.rb +10 -10
  33. data/lib/orb/models/plan.rb +618 -9
  34. data/lib/orb/models/plan_create_params.rb +2066 -30
  35. data/lib/orb/models/plan_version.rb +735 -0
  36. data/lib/orb/models/plan_version_phase.rb +70 -0
  37. data/lib/orb/models/price.rb +4124 -70
  38. data/lib/orb/models/price_create_params.rb +45 -1
  39. data/lib/orb/models/price_evaluate_multiple_params.rb +8620 -0
  40. data/lib/orb/models/price_evaluate_multiple_response.rb +51 -0
  41. data/lib/orb/models/subscription.rb +730 -54
  42. data/lib/orb/models/subscription_cancel_response.rb +706 -54
  43. data/lib/orb/models/subscription_change_apply_response.rb +728 -54
  44. data/lib/orb/models/subscription_change_cancel_response.rb +728 -54
  45. data/lib/orb/models/subscription_change_retrieve_response.rb +728 -54
  46. data/lib/orb/models/subscription_create_params.rb +5992 -1698
  47. data/lib/orb/models/subscription_create_response.rb +706 -54
  48. data/lib/orb/models/subscription_fetch_schedule_response.rb +3 -3
  49. data/lib/orb/models/subscription_price_intervals_params.rb +1392 -76
  50. data/lib/orb/models/subscription_price_intervals_response.rb +712 -54
  51. data/lib/orb/models/subscription_schedule_plan_change_params.rb +6005 -1723
  52. data/lib/orb/models/subscription_schedule_plan_change_response.rb +716 -54
  53. data/lib/orb/models/subscription_trigger_phase_response.rb +708 -54
  54. data/lib/orb/models/subscription_unschedule_cancellation_response.rb +720 -54
  55. data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +728 -54
  56. data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +728 -54
  57. data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +1 -1
  58. data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +720 -54
  59. data/lib/orb/models/subscription_update_trial_response.rb +706 -54
  60. data/lib/orb/models/trial_discount.rb +10 -10
  61. data/lib/orb/models/usage_discount.rb +10 -10
  62. data/lib/orb/models.rb +16 -0
  63. data/lib/orb/resources/beta/external_plan_id.rb +113 -0
  64. data/lib/orb/resources/beta.rb +115 -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.rb +1 -1
  71. data/lib/orb/resources/plans.rb +2 -2
  72. data/lib/orb/resources/prices.rb +69 -2
  73. data/lib/orb/resources/subscriptions.rb +5 -1
  74. data/lib/orb/version.rb +1 -1
  75. data/lib/orb.rb +13 -0
  76. data/rbi/orb/client.rbi +3 -0
  77. data/rbi/orb/models/alert.rbi +50 -3
  78. data/rbi/orb/models/amount_discount.rbi +8 -8
  79. data/rbi/orb/models/beta/external_plan_id_create_plan_version_params.rbi +32652 -0
  80. data/rbi/orb/models/beta/external_plan_id_fetch_plan_version_params.rbi +40 -0
  81. data/rbi/orb/models/beta/external_plan_id_set_default_plan_version_params.rbi +45 -0
  82. data/rbi/orb/models/beta_create_plan_version_params.rbi +32595 -0
  83. data/rbi/orb/models/beta_fetch_plan_version_params.rbi +35 -0
  84. data/rbi/orb/models/beta_set_default_plan_version_params.rbi +40 -0
  85. data/rbi/orb/models/credit_note_create_params.rbi +8 -8
  86. data/rbi/orb/models/customer_create_params.rbi +38 -4
  87. data/rbi/orb/models/customer_update_by_external_id_params.rbi +38 -4
  88. data/rbi/orb/models/customer_update_params.rbi +38 -4
  89. data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +9 -1
  90. data/rbi/orb/models/customers/credits/ledger_create_entry_response.rbi +9 -1
  91. data/rbi/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +9 -1
  92. data/rbi/orb/models/customers/credits/ledger_list_response.rbi +9 -1
  93. data/rbi/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +2 -2
  94. data/rbi/orb/models/customers/credits/top_up_create_params.rbi +2 -2
  95. data/rbi/orb/models/invoice.rbi +1451 -35
  96. data/rbi/orb/models/invoice_fetch_upcoming_response.rbi +1524 -4
  97. data/rbi/orb/models/invoice_line_item_create_response.rbi +1184 -2
  98. data/rbi/orb/models/item.rbi +20 -1
  99. data/rbi/orb/models/item_archive_params.rbi +25 -0
  100. data/rbi/orb/models/item_create_params.rbi +18 -1
  101. data/rbi/orb/models/item_update_params.rbi +17 -1
  102. data/rbi/orb/models/percentage_discount.rbi +10 -10
  103. data/rbi/orb/models/plan.rbi +1339 -4
  104. data/rbi/orb/models/plan_create_params.rbi +3833 -29
  105. data/rbi/orb/models/plan_version.rbi +1367 -0
  106. data/rbi/orb/models/plan_version_phase.rbi +99 -0
  107. data/rbi/orb/models/price.rbi +9447 -441
  108. data/rbi/orb/models/price_create_params.rbi +80 -0
  109. data/rbi/orb/models/price_evaluate_multiple_params.rbi +15764 -0
  110. data/rbi/orb/models/price_evaluate_multiple_response.rbi +96 -0
  111. data/rbi/orb/models/subscription.rbi +1654 -44
  112. data/rbi/orb/models/subscription_cancel_response.rbi +1692 -44
  113. data/rbi/orb/models/subscription_change_apply_response.rbi +1692 -44
  114. data/rbi/orb/models/subscription_change_cancel_response.rbi +1692 -44
  115. data/rbi/orb/models/subscription_change_retrieve_response.rbi +1692 -44
  116. data/rbi/orb/models/subscription_create_params.rbi +10400 -2710
  117. data/rbi/orb/models/subscription_create_response.rbi +1692 -44
  118. data/rbi/orb/models/subscription_fetch_schedule_response.rbi +13 -4
  119. data/rbi/orb/models/subscription_price_intervals_params.rbi +2401 -49
  120. data/rbi/orb/models/subscription_price_intervals_response.rbi +1692 -44
  121. data/rbi/orb/models/subscription_schedule_plan_change_params.rbi +10423 -2753
  122. data/rbi/orb/models/subscription_schedule_plan_change_response.rbi +1692 -44
  123. data/rbi/orb/models/subscription_trigger_phase_response.rbi +1692 -44
  124. data/rbi/orb/models/subscription_unschedule_cancellation_response.rbi +1692 -44
  125. data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +1692 -44
  126. data/rbi/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +1692 -44
  127. data/rbi/orb/models/subscription_update_fixed_fee_quantity_params.rbi +2 -2
  128. data/rbi/orb/models/subscription_update_fixed_fee_quantity_response.rbi +1692 -44
  129. data/rbi/orb/models/subscription_update_trial_response.rbi +1692 -44
  130. data/rbi/orb/models/trial_discount.rbi +8 -8
  131. data/rbi/orb/models/usage_discount.rbi +10 -10
  132. data/rbi/orb/models.rbi +16 -0
  133. data/rbi/orb/resources/beta/external_plan_id.rbi +118 -0
  134. data/rbi/orb/resources/beta.rbi +111 -0
  135. data/rbi/orb/resources/credit_notes.rbi +3 -3
  136. data/rbi/orb/resources/customers/balance_transactions.rbi +0 -7
  137. data/rbi/orb/resources/customers/credits/top_ups.rbi +2 -2
  138. data/rbi/orb/resources/customers.rbi +7 -7
  139. data/rbi/orb/resources/dimensional_price_groups.rbi +1 -1
  140. data/rbi/orb/resources/items.rbi +20 -0
  141. data/rbi/orb/resources/plans/external_plan_id.rbi +1 -1
  142. data/rbi/orb/resources/plans.rbi +5 -2
  143. data/rbi/orb/resources/prices.rbi +73 -1
  144. data/rbi/orb/resources/subscriptions.rbi +9 -1
  145. data/sig/orb/client.rbs +2 -0
  146. data/sig/orb/models/alert.rbs +20 -3
  147. data/sig/orb/models/amount_discount.rbs +5 -5
  148. data/sig/orb/models/beta/external_plan_id_create_plan_version_params.rbs +12898 -0
  149. data/sig/orb/models/beta/external_plan_id_fetch_plan_version_params.rbs +25 -0
  150. data/sig/orb/models/beta/external_plan_id_set_default_plan_version_params.rbs +25 -0
  151. data/sig/orb/models/beta_create_plan_version_params.rbs +12877 -0
  152. data/sig/orb/models/beta_fetch_plan_version_params.rbs +20 -0
  153. data/sig/orb/models/beta_set_default_plan_version_params.rbs +20 -0
  154. data/sig/orb/models/credit_note_create_params.rbs +6 -6
  155. data/sig/orb/models/customer_create_params.rbs +13 -0
  156. data/sig/orb/models/customer_update_by_external_id_params.rbs +13 -0
  157. data/sig/orb/models/customer_update_params.rbs +13 -0
  158. data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +7 -2
  159. data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +7 -2
  160. data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +7 -2
  161. data/sig/orb/models/customers/credits/ledger_list_response.rbs +7 -2
  162. data/sig/orb/models/invoice.rbs +558 -4
  163. data/sig/orb/models/invoice_fetch_upcoming_response.rbs +558 -4
  164. data/sig/orb/models/invoice_line_item_create_response.rbs +414 -2
  165. data/sig/orb/models/item.rbs +5 -0
  166. data/sig/orb/models/item_archive_params.rbs +14 -0
  167. data/sig/orb/models/item_create_params.rbs +10 -2
  168. data/sig/orb/models/item_update_params.rbs +5 -0
  169. data/sig/orb/models/percentage_discount.rbs +5 -5
  170. data/sig/orb/models/plan.rbs +538 -4
  171. data/sig/orb/models/plan_create_params.rbs +1460 -3
  172. data/sig/orb/models/plan_version.rbs +583 -0
  173. data/sig/orb/models/plan_version_phase.rbs +60 -0
  174. data/sig/orb/models/price.rbs +3512 -96
  175. data/sig/orb/models/price_create_params.rbs +32 -0
  176. data/sig/orb/models/price_evaluate_multiple_params.rbs +6230 -0
  177. data/sig/orb/models/price_evaluate_multiple_response.rbs +50 -0
  178. data/sig/orb/models/subscription.rbs +609 -29
  179. data/sig/orb/models/subscription_cancel_response.rbs +609 -29
  180. data/sig/orb/models/subscription_change_apply_response.rbs +621 -29
  181. data/sig/orb/models/subscription_change_cancel_response.rbs +621 -29
  182. data/sig/orb/models/subscription_change_retrieve_response.rbs +621 -29
  183. data/sig/orb/models/subscription_create_params.rbs +4450 -1466
  184. data/sig/orb/models/subscription_create_response.rbs +609 -29
  185. data/sig/orb/models/subscription_fetch_schedule_response.rbs +4 -4
  186. data/sig/orb/models/subscription_price_intervals_params.rbs +920 -24
  187. data/sig/orb/models/subscription_price_intervals_response.rbs +609 -29
  188. data/sig/orb/models/subscription_schedule_plan_change_params.rbs +4440 -1466
  189. data/sig/orb/models/subscription_schedule_plan_change_response.rbs +609 -29
  190. data/sig/orb/models/subscription_trigger_phase_response.rbs +609 -29
  191. data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +609 -29
  192. data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +609 -29
  193. data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +609 -29
  194. data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +609 -29
  195. data/sig/orb/models/subscription_update_trial_response.rbs +609 -29
  196. data/sig/orb/models/trial_discount.rbs +5 -5
  197. data/sig/orb/models/usage_discount.rbs +5 -5
  198. data/sig/orb/models.rbs +16 -0
  199. data/sig/orb/resources/beta/external_plan_id.rbs +34 -0
  200. data/sig/orb/resources/beta.rbs +34 -0
  201. data/sig/orb/resources/credit_notes.rbs +1 -1
  202. data/sig/orb/resources/items.rbs +7 -0
  203. data/sig/orb/resources/prices.rbs +11 -0
  204. data/sig/orb/resources/subscriptions.rbs +2 -0
  205. metadata +40 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: c8f8963482bbf7d53f0eca5aaf33903328ef6b33c07568c87f55e254c60c995b
4
- data.tar.gz: 76f59da8f86eaf4b8309ec94b885fed6a786efa65d18c6b093955342509831eb
3
+ metadata.gz: dad66a8975532dada27f6ccd45c30a2d97fc1334e417d96bd5123cf31638f1e4
4
+ data.tar.gz: 40a105a901a0d0bd2472a4c1226068af5a7ddcd8be89d1bb514a6c4dfd4821f2
5
5
  SHA512:
6
- metadata.gz: a3b0c5cbf887d115e30a9032023ad9c89c88304c9a4b0c06341a8d6e50becea33718a88bf2440b897df6501b89dc4998fd3d2c10fed32d67c71e63e323d0ecf7
7
- data.tar.gz: 45017934cba07aeae4300210d8a9436dc615d60aeb36fd5afcc69a2a9ef15876e8e2a40700b87db217de92c58bc33b755ef1ae93454855c7c3cf5e7a4d3a5f0e
6
+ metadata.gz: a7d81a8f1ad17e5fb82969800b5059ddfc34777205bfeb3d8ad25863e7d8cfee2f9e97cdfffa66b4fa6bd1b6c3eec46daa1618c8f34a9292f87091d6854549ed
7
+ data.tar.gz: 154c6ed79392ad5ced3f83e5750b9b06b4c06c57e705753874baba8b7845f6eea93dc8a6526828451d331be82a0a4c117c54df55939a955fefee2425f3cdae33
data/CHANGELOG.md CHANGED
@@ -1,5 +1,31 @@
1
1
  # Changelog
2
2
 
3
+ ## 0.7.0 (2025-05-28)
4
+
5
+ Full Changelog: [v0.6.0...v0.7.0](https://github.com/orbcorp/orb-ruby/compare/v0.6.0...v0.7.0)
6
+
7
+ ### Features
8
+
9
+ * **api:** manual updates ([1f22c08](https://github.com/orbcorp/orb-ruby/commit/1f22c08f203c9fa6b2ec899cb12e1317385b4d85))
10
+
11
+
12
+ ### Chores
13
+
14
+ * **internal:** version bump ([ee634ed](https://github.com/orbcorp/orb-ruby/commit/ee634edb35370185e6e772957a9a0340b9066749))
15
+
16
+ ## 0.6.0 (2025-05-28)
17
+
18
+ Full Changelog: [v0.5.5...v0.6.0](https://github.com/orbcorp/orb-ruby/compare/v0.5.5...v0.6.0)
19
+
20
+ ### Features
21
+
22
+ * **api:** api update ([cb1cc2c](https://github.com/orbcorp/orb-ruby/commit/cb1cc2c7a37d5f73c19b077316e20778da10f511))
23
+
24
+
25
+ ### Chores
26
+
27
+ * **internal:** version bump ([0b5d352](https://github.com/orbcorp/orb-ruby/commit/0b5d35296a75187866272653c9b70d3428d8e6f3))
28
+
3
29
  ## 0.5.5 (2025-05-27)
4
30
 
5
31
  Full Changelog: [v0.5.4...v0.5.5](https://github.com/orbcorp/orb-ruby/compare/v0.5.4...v0.5.5)
data/README.md CHANGED
@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
15
15
  <!-- x-release-please-start-version -->
16
16
 
17
17
  ```ruby
18
- gem "orb-billing", "~> 0.5.5"
18
+ gem "orb-billing", "~> 0.7.0"
19
19
  ```
20
20
 
21
21
  <!-- x-release-please-end -->
data/lib/orb/client.rb CHANGED
@@ -21,6 +21,9 @@ module Orb
21
21
  # @return [Orb::Resources::TopLevel]
22
22
  attr_reader :top_level
23
23
 
24
+ # @return [Orb::Resources::Beta]
25
+ attr_reader :beta
26
+
24
27
  # @return [Orb::Resources::Coupons]
25
28
  attr_reader :coupons
26
29
 
@@ -115,6 +118,7 @@ module Orb
115
118
  )
116
119
 
117
120
  @top_level = Orb::Resources::TopLevel.new(client: self)
121
+ @beta = Orb::Resources::Beta.new(client: self)
118
122
  @coupons = Orb::Resources::Coupons.new(client: self)
119
123
  @credit_notes = Orb::Resources::CreditNotes.new(client: self)
120
124
  @customers = Orb::Resources::Customers.new(client: self)
@@ -398,8 +398,8 @@ module Orb
398
398
  # # `amount_discount` is a `Orb::AmountDiscount`
399
399
  # amount_discount => {
400
400
  # amount_discount: amount_discount,
401
- # applies_to_price_ids: applies_to_price_ids,
402
- # discount_type: discount_type
401
+ # discount_type: discount_type,
402
+ # applies_to_price_ids: applies_to_price_ids
403
403
  # }
404
404
  def deconstruct_keys(keys)
405
405
  (keys || self.class.known_fields.keys)
@@ -9,9 +9,9 @@ module Orb
9
9
  # # `discount` is a `Orb::Discount`
10
10
  # case discount
11
11
  # when Orb::PercentageDiscount
12
- # puts(discount.applies_to_price_ids)
13
- # when Orb::TrialDiscount
14
12
  # puts(discount.discount_type)
13
+ # when Orb::TrialDiscount
14
+ # puts(discount.applies_to_price_ids)
15
15
  # when Orb::UsageDiscount
16
16
  # puts(discount.usage_discount)
17
17
  # else
@@ -22,22 +22,22 @@ module Orb
22
22
  # case discount
23
23
  # in {
24
24
  # discount_type: :percentage,
25
- # applies_to_price_ids: applies_to_price_ids,
26
25
  # percentage_discount: percentage_discount,
26
+ # applies_to_price_ids: applies_to_price_ids,
27
27
  # reason: reason
28
28
  # }
29
- # puts(applies_to_price_ids)
29
+ # puts(percentage_discount)
30
30
  # in {
31
31
  # discount_type: :trial,
32
32
  # applies_to_price_ids: applies_to_price_ids,
33
33
  # reason: reason,
34
34
  # trial_amount_discount: trial_amount_discount
35
35
  # }
36
- # puts(reason)
36
+ # puts(applies_to_price_ids)
37
37
  # in {
38
38
  # discount_type: :usage,
39
- # applies_to_price_ids: applies_to_price_ids,
40
39
  # usage_discount: usage_discount,
40
+ # applies_to_price_ids: applies_to_price_ids,
41
41
  # reason: reason
42
42
  # }
43
43
  # puts(usage_discount)
@@ -65,7 +65,16 @@ module Orb
65
65
  # @return [Symbol, Orb::Models::Alert::Type]
66
66
  required :type, enum: -> { Orb::Alert::Type }
67
67
 
68
- # @!method initialize(id:, created_at:, currency:, customer:, enabled:, metric:, plan:, subscription:, thresholds:, type:)
68
+ # @!attribute balance_alert_status
69
+ # The current status of the alert. This field is only present for credit balance
70
+ # alerts.
71
+ #
72
+ # @return [Array<Orb::Models::Alert::BalanceAlertStatus>, nil]
73
+ optional :balance_alert_status,
74
+ -> { Orb::Internal::Type::ArrayOf[Orb::Alert::BalanceAlertStatus] },
75
+ nil?: true
76
+
77
+ # @!method initialize(id:, created_at:, currency:, customer:, enabled:, metric:, plan:, subscription:, thresholds:, type:, balance_alert_status: nil)
69
78
  # Some parameter documentations has been truncated, see {Orb::Models::Alert} for
70
79
  # more details.
71
80
  #
@@ -94,6 +103,8 @@ module Orb
94
103
  # @param thresholds [Array<Orb::Models::Alert::Threshold>, nil] The thresholds that define the conditions under which the alert will be triggere
95
104
  #
96
105
  # @param type [Symbol, Orb::Models::Alert::Type] The type of alert. This must be a valid alert type.
106
+ #
107
+ # @param balance_alert_status [Array<Orb::Models::Alert::BalanceAlertStatus>, nil] The current status of the alert. This field is only present for credit balance a
97
108
 
98
109
  # @see Orb::Models::Alert#customer
99
110
  class Customer < Orb::Internal::Type::BaseModel
@@ -214,6 +225,27 @@ module Orb
214
225
  # @!method self.values
215
226
  # @return [Array<Symbol>]
216
227
  end
228
+
229
+ class BalanceAlertStatus < Orb::Internal::Type::BaseModel
230
+ # @!attribute in_alert
231
+ # Whether the alert is currently in-alert or not.
232
+ #
233
+ # @return [Boolean]
234
+ required :in_alert, Orb::Internal::Type::Boolean
235
+
236
+ # @!attribute threshold_value
237
+ # The value of the threshold that defines the alert status.
238
+ #
239
+ # @return [Float]
240
+ required :threshold_value, Float
241
+
242
+ # @!method initialize(in_alert:, threshold_value:)
243
+ # Alert status is used to determine if an alert is currently in-alert or not.
244
+ #
245
+ # @param in_alert [Boolean] Whether the alert is currently in-alert or not.
246
+ #
247
+ # @param threshold_value [Float] The value of the threshold that defines the alert status.
248
+ end
217
249
  end
218
250
  end
219
251
  end
@@ -9,33 +9,33 @@ module Orb
9
9
  # @return [String]
10
10
  required :amount_discount, String
11
11
 
12
- # @!attribute applies_to_price_ids
13
- # List of price_ids that this discount applies to. For plan/plan phase discounts,
14
- # this can be a subset of prices.
15
- #
16
- # @return [Array<String>]
17
- required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
18
-
19
12
  # @!attribute discount_type
20
13
  #
21
14
  # @return [Symbol, Orb::Models::AmountDiscount::DiscountType]
22
15
  required :discount_type, enum: -> { Orb::AmountDiscount::DiscountType }
23
16
 
17
+ # @!attribute applies_to_price_ids
18
+ # List of price_ids that this discount applies to. For plan/plan phase discounts,
19
+ # this can be a subset of prices.
20
+ #
21
+ # @return [Array<String>, nil]
22
+ optional :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String], nil?: true
23
+
24
24
  # @!attribute reason
25
25
  #
26
26
  # @return [String, nil]
27
27
  optional :reason, String, nil?: true
28
28
 
29
- # @!method initialize(amount_discount:, applies_to_price_ids:, discount_type:, reason: nil)
29
+ # @!method initialize(amount_discount:, discount_type:, applies_to_price_ids: nil, reason: nil)
30
30
  # Some parameter documentations has been truncated, see
31
31
  # {Orb::Models::AmountDiscount} for more details.
32
32
  #
33
33
  # @param amount_discount [String] Only available if discount_type is `amount`.
34
34
  #
35
- # @param applies_to_price_ids [Array<String>] List of price_ids that this discount applies to. For plan/plan phase discounts,
36
- #
37
35
  # @param discount_type [Symbol, Orb::Models::AmountDiscount::DiscountType]
38
36
  #
37
+ # @param applies_to_price_ids [Array<String>, nil] List of price_ids that this discount applies to. For plan/plan phase discounts,
38
+ #
39
39
  # @param reason [String, nil]
40
40
 
41
41
  # @see Orb::Models::AmountDiscount#discount_type