orb-billing 1.46.0 → 1.47.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 (141) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +17 -1
  3. data/README.md +1 -1
  4. data/lib/orb/models/invoice_issue_summary_response.rb +2 -1
  5. data/lib/orb/models/invoice_issued_summary_webhook_event.rb +5 -3
  6. data/lib/orb/models/invoice_list_summary_response.rb +2 -1
  7. data/lib/orb/models/metric_list_params.rb +21 -1
  8. data/lib/orb/models/metric_update_params.rb +17 -1
  9. data/lib/orb/models/plan_update_params.rb +9 -1
  10. data/lib/orb/models/plans/external_plan_id_update_params.rb +9 -1
  11. data/lib/orb/models/subscription_alert_disabled_webhook_event.rb +5 -9
  12. data/lib/orb/models/subscription_grouped_cost_exceeded_webhook_event.rb +5 -9
  13. data/lib/orb/models/subscription_invoicing_threshold_exceeded_webhook_event.rb +5 -9
  14. data/lib/orb/models/subscription_license_allocation_reset_webhook_event.rb +5 -9
  15. data/lib/orb/models/subscription_license_balance_threshold_reached_webhook_event.rb +5 -9
  16. data/lib/orb/models/webhook_endpoint.rb +28 -1
  17. data/lib/orb/models/webhook_endpoint_create_params.rb +22 -1
  18. data/lib/orb/models/webhook_endpoint_update_params.rb +22 -1
  19. data/lib/orb/models/webhook_endpoint_with_secret.rb +28 -1
  20. data/lib/orb/models/webhooks/invoice_accounting_sync_failed_standard_webhook_event.rb +5 -3
  21. data/lib/orb/models/webhooks/invoice_accounting_sync_succeeded_standard_webhook_event.rb +5 -3
  22. data/lib/orb/models/webhooks/invoice_dunning_schedule_created_standard_webhook_event.rb +5 -3
  23. data/lib/orb/models/webhooks/invoice_dunning_schedule_ended_standard_webhook_event.rb +5 -3
  24. data/lib/orb/models/webhooks/invoice_dunning_schedule_reset_standard_webhook_event.rb +5 -3
  25. data/lib/orb/models/webhooks/invoice_dunning_schedule_step_executed_standard_webhook_event.rb +5 -3
  26. data/lib/orb/models/webhooks/invoice_edited_standard_webhook_event.rb +5 -3
  27. data/lib/orb/models/webhooks/invoice_issue_failed_standard_webhook_event.rb +5 -3
  28. data/lib/orb/models/webhooks/invoice_issued_standard_webhook_event.rb +5 -3
  29. data/lib/orb/models/webhooks/invoice_issued_summary_standard_webhook_event.rb +5 -3
  30. data/lib/orb/models/webhooks/invoice_manually_marked_as_paid_standard_webhook_event.rb +5 -3
  31. data/lib/orb/models/webhooks/invoice_manually_marked_as_void_standard_webhook_event.rb +5 -3
  32. data/lib/orb/models/webhooks/invoice_payment_failed_standard_webhook_event.rb +5 -3
  33. data/lib/orb/models/webhooks/invoice_payment_processing_standard_webhook_event.rb +5 -3
  34. data/lib/orb/models/webhooks/invoice_payment_succeeded_standard_webhook_event.rb +5 -3
  35. data/lib/orb/models/webhooks/invoice_sync_failed_standard_webhook_event.rb +5 -3
  36. data/lib/orb/models/webhooks/invoice_sync_succeeded_standard_webhook_event.rb +5 -3
  37. data/lib/orb/models/webhooks/invoice_undo_mark_as_paid_standard_webhook_event.rb +5 -3
  38. data/lib/orb/models/webhooks/sales_order_accounting_sync_failed_standard_webhook_event.rb +5 -3
  39. data/lib/orb/models/webhooks/sales_order_accounting_sync_succeeded_standard_webhook_event.rb +5 -3
  40. data/lib/orb/models/webhooks/subscription_accounting_sync_failed_standard_webhook_event.rb +7 -7
  41. data/lib/orb/models/webhooks/subscription_accounting_sync_succeeded_standard_webhook_event.rb +7 -7
  42. data/lib/orb/models/webhooks/subscription_alert_disabled_standard_webhook_event.rb +5 -9
  43. data/lib/orb/models/webhooks/subscription_cancellation_scheduled_standard_webhook_event.rb +7 -7
  44. data/lib/orb/models/webhooks/subscription_cancellation_unscheduled_standard_webhook_event.rb +7 -7
  45. data/lib/orb/models/webhooks/subscription_cost_exceeded_standard_webhook_event.rb +7 -7
  46. data/lib/orb/models/webhooks/subscription_created_standard_webhook_event.rb +7 -7
  47. data/lib/orb/models/webhooks/subscription_edited_standard_webhook_event.rb +7 -7
  48. data/lib/orb/models/webhooks/subscription_ended_standard_webhook_event.rb +7 -7
  49. data/lib/orb/models/webhooks/subscription_fixed_fee_quantity_updated_standard_webhook_event.rb +7 -7
  50. data/lib/orb/models/webhooks/subscription_grouped_cost_exceeded_standard_webhook_event.rb +5 -9
  51. data/lib/orb/models/webhooks/subscription_invoicing_threshold_exceeded_standard_webhook_event.rb +5 -9
  52. data/lib/orb/models/webhooks/subscription_license_allocation_reset_standard_webhook_event.rb +5 -9
  53. data/lib/orb/models/webhooks/subscription_license_balance_threshold_reached_standard_webhook_event.rb +5 -9
  54. data/lib/orb/models/webhooks/subscription_plan_change_scheduled_standard_webhook_event.rb +7 -7
  55. data/lib/orb/models/webhooks/subscription_plan_changed_standard_webhook_event.rb +7 -7
  56. data/lib/orb/models/webhooks/subscription_plan_version_change_scheduled_standard_webhook_event.rb +7 -7
  57. data/lib/orb/models/webhooks/subscription_plan_version_changed_standard_webhook_event.rb +7 -7
  58. data/lib/orb/models/webhooks/subscription_spend_exceeded_standard_webhook_event.rb +7 -7
  59. data/lib/orb/models/webhooks/subscription_started_standard_webhook_event.rb +7 -7
  60. data/lib/orb/models/webhooks/subscription_trial_ended_standard_webhook_event.rb +7 -7
  61. data/lib/orb/models/webhooks/subscription_usage_exceeded_standard_webhook_event.rb +7 -7
  62. data/lib/orb/resources/metrics.rb +15 -5
  63. data/lib/orb/resources/plans/external_plan_id.rb +6 -3
  64. data/lib/orb/resources/plans.rb +6 -3
  65. data/lib/orb/resources/webhook_endpoints.rb +6 -2
  66. data/lib/orb/version.rb +1 -1
  67. data/rbi/orb/models/invoice_issue_summary_response.rbi +2 -1
  68. data/rbi/orb/models/invoice_issued_summary_webhook_event.rbi +6 -3
  69. data/rbi/orb/models/invoice_list_summary_response.rbi +2 -1
  70. data/rbi/orb/models/metric_list_params.rbi +29 -0
  71. data/rbi/orb/models/metric_update_params.rbi +16 -0
  72. data/rbi/orb/models/plan_update_params.rbi +8 -0
  73. data/rbi/orb/models/plans/external_plan_id_update_params.rbi +8 -0
  74. data/rbi/orb/models/subscription_alert_disabled_webhook_event.rbi +6 -12
  75. data/rbi/orb/models/subscription_grouped_cost_exceeded_webhook_event.rbi +6 -12
  76. data/rbi/orb/models/subscription_invoicing_threshold_exceeded_webhook_event.rbi +6 -12
  77. data/rbi/orb/models/subscription_license_allocation_reset_webhook_event.rbi +6 -12
  78. data/rbi/orb/models/subscription_license_balance_threshold_reached_webhook_event.rbi +6 -12
  79. data/rbi/orb/models/webhook_endpoint.rbi +39 -0
  80. data/rbi/orb/models/webhook_endpoint_create_params.rbi +51 -0
  81. data/rbi/orb/models/webhook_endpoint_update_params.rbi +51 -0
  82. data/rbi/orb/models/webhook_endpoint_with_secret.rbi +50 -0
  83. data/rbi/orb/models/webhooks/invoice_accounting_sync_failed_standard_webhook_event.rbi +6 -3
  84. data/rbi/orb/models/webhooks/invoice_accounting_sync_succeeded_standard_webhook_event.rbi +6 -3
  85. data/rbi/orb/models/webhooks/invoice_dunning_schedule_created_standard_webhook_event.rbi +6 -3
  86. data/rbi/orb/models/webhooks/invoice_dunning_schedule_ended_standard_webhook_event.rbi +6 -3
  87. data/rbi/orb/models/webhooks/invoice_dunning_schedule_reset_standard_webhook_event.rbi +6 -3
  88. data/rbi/orb/models/webhooks/invoice_dunning_schedule_step_executed_standard_webhook_event.rbi +6 -3
  89. data/rbi/orb/models/webhooks/invoice_edited_standard_webhook_event.rbi +6 -3
  90. data/rbi/orb/models/webhooks/invoice_issue_failed_standard_webhook_event.rbi +6 -3
  91. data/rbi/orb/models/webhooks/invoice_issued_standard_webhook_event.rbi +6 -3
  92. data/rbi/orb/models/webhooks/invoice_issued_summary_standard_webhook_event.rbi +6 -3
  93. data/rbi/orb/models/webhooks/invoice_manually_marked_as_paid_standard_webhook_event.rbi +6 -3
  94. data/rbi/orb/models/webhooks/invoice_manually_marked_as_void_standard_webhook_event.rbi +6 -3
  95. data/rbi/orb/models/webhooks/invoice_payment_failed_standard_webhook_event.rbi +6 -3
  96. data/rbi/orb/models/webhooks/invoice_payment_processing_standard_webhook_event.rbi +6 -3
  97. data/rbi/orb/models/webhooks/invoice_payment_succeeded_standard_webhook_event.rbi +6 -3
  98. data/rbi/orb/models/webhooks/invoice_sync_failed_standard_webhook_event.rbi +6 -3
  99. data/rbi/orb/models/webhooks/invoice_sync_succeeded_standard_webhook_event.rbi +6 -3
  100. data/rbi/orb/models/webhooks/invoice_undo_mark_as_paid_standard_webhook_event.rbi +6 -3
  101. data/rbi/orb/models/webhooks/sales_order_accounting_sync_failed_standard_webhook_event.rbi +6 -3
  102. data/rbi/orb/models/webhooks/sales_order_accounting_sync_succeeded_standard_webhook_event.rbi +6 -3
  103. data/rbi/orb/models/webhooks/subscription_accounting_sync_failed_standard_webhook_event.rbi +9 -9
  104. data/rbi/orb/models/webhooks/subscription_accounting_sync_succeeded_standard_webhook_event.rbi +9 -9
  105. data/rbi/orb/models/webhooks/subscription_alert_disabled_standard_webhook_event.rbi +6 -12
  106. data/rbi/orb/models/webhooks/subscription_cancellation_scheduled_standard_webhook_event.rbi +9 -9
  107. data/rbi/orb/models/webhooks/subscription_cancellation_unscheduled_standard_webhook_event.rbi +9 -9
  108. data/rbi/orb/models/webhooks/subscription_cost_exceeded_standard_webhook_event.rbi +9 -9
  109. data/rbi/orb/models/webhooks/subscription_created_standard_webhook_event.rbi +9 -9
  110. data/rbi/orb/models/webhooks/subscription_edited_standard_webhook_event.rbi +9 -9
  111. data/rbi/orb/models/webhooks/subscription_ended_standard_webhook_event.rbi +9 -9
  112. data/rbi/orb/models/webhooks/subscription_fixed_fee_quantity_updated_standard_webhook_event.rbi +9 -9
  113. data/rbi/orb/models/webhooks/subscription_grouped_cost_exceeded_standard_webhook_event.rbi +6 -12
  114. data/rbi/orb/models/webhooks/subscription_invoicing_threshold_exceeded_standard_webhook_event.rbi +6 -12
  115. data/rbi/orb/models/webhooks/subscription_license_allocation_reset_standard_webhook_event.rbi +6 -12
  116. data/rbi/orb/models/webhooks/subscription_license_balance_threshold_reached_standard_webhook_event.rbi +6 -12
  117. data/rbi/orb/models/webhooks/subscription_plan_change_scheduled_standard_webhook_event.rbi +9 -9
  118. data/rbi/orb/models/webhooks/subscription_plan_changed_standard_webhook_event.rbi +9 -9
  119. data/rbi/orb/models/webhooks/subscription_plan_version_change_scheduled_standard_webhook_event.rbi +9 -9
  120. data/rbi/orb/models/webhooks/subscription_plan_version_changed_standard_webhook_event.rbi +9 -9
  121. data/rbi/orb/models/webhooks/subscription_spend_exceeded_standard_webhook_event.rbi +9 -9
  122. data/rbi/orb/models/webhooks/subscription_started_standard_webhook_event.rbi +9 -9
  123. data/rbi/orb/models/webhooks/subscription_trial_ended_standard_webhook_event.rbi +9 -9
  124. data/rbi/orb/models/webhooks/subscription_usage_exceeded_standard_webhook_event.rbi +9 -9
  125. data/rbi/orb/resources/metrics.rbi +16 -3
  126. data/rbi/orb/resources/plans/external_plan_id.rbi +6 -2
  127. data/rbi/orb/resources/plans.rbi +6 -2
  128. data/rbi/orb/resources/webhook_endpoints.rbi +10 -0
  129. data/sig/orb/models/metric_list_params.rbs +18 -1
  130. data/sig/orb/models/metric_update_params.rbs +14 -1
  131. data/sig/orb/models/plan_update_params.rbs +6 -1
  132. data/sig/orb/models/plans/external_plan_id_update_params.rbs +6 -1
  133. data/sig/orb/models/webhook_endpoint.rbs +16 -0
  134. data/sig/orb/models/webhook_endpoint_create_params.rbs +20 -1
  135. data/sig/orb/models/webhook_endpoint_update_params.rbs +16 -0
  136. data/sig/orb/models/webhook_endpoint_with_secret.rbs +16 -0
  137. data/sig/orb/resources/metrics.rbs +3 -0
  138. data/sig/orb/resources/plans/external_plan_id.rbs +1 -0
  139. data/sig/orb/resources/plans.rbs +1 -0
  140. data/sig/orb/resources/webhook_endpoints.rbs +2 -0
  141. metadata +1 -1
@@ -20,7 +20,8 @@ module Orb
20
20
  sig { returns(Time) }
21
21
  attr_accessor :created_at
22
22
 
23
- # #InvoiceApiResourceWithoutLineItems
23
+ # An invoice without its line items, subtotal, discounts, minimums or maximums.
24
+ # Fetch the invoice for those.
24
25
  sig do
25
26
  returns(
26
27
  Orb::Webhooks::InvoiceManuallyMarkedAsPaidStandardWebhookEvent::Invoice
@@ -88,7 +89,8 @@ module Orb
88
89
  id:,
89
90
  # The time at which this event was created, to the second.
90
91
  created_at:,
91
- # #InvoiceApiResourceWithoutLineItems
92
+ # An invoice without its line items, subtotal, discounts, minimums or maximums.
93
+ # Fetch the invoice for those.
92
94
  invoice:,
93
95
  # The serialization style this payload was rendered in, as configured on the
94
96
  # endpoint.
@@ -488,7 +490,8 @@ module Orb
488
490
  sig { returns(T::Boolean) }
489
491
  attr_accessor :will_auto_issue
490
492
 
491
- # #InvoiceApiResourceWithoutLineItems
493
+ # An invoice without its line items, subtotal, discounts, minimums or maximums.
494
+ # Fetch the invoice for those.
492
495
  sig do
493
496
  params(
494
497
  id: String,
@@ -20,7 +20,8 @@ module Orb
20
20
  sig { returns(Time) }
21
21
  attr_accessor :created_at
22
22
 
23
- # #InvoiceApiResourceWithoutLineItems
23
+ # An invoice without its line items, subtotal, discounts, minimums or maximums.
24
+ # Fetch the invoice for those.
24
25
  sig do
25
26
  returns(
26
27
  Orb::Webhooks::InvoiceManuallyMarkedAsVoidStandardWebhookEvent::Invoice
@@ -75,7 +76,8 @@ module Orb
75
76
  id:,
76
77
  # The time at which this event was created, to the second.
77
78
  created_at:,
78
- # #InvoiceApiResourceWithoutLineItems
79
+ # An invoice without its line items, subtotal, discounts, minimums or maximums.
80
+ # Fetch the invoice for those.
79
81
  invoice:,
80
82
  # The serialization style this payload was rendered in, as configured on the
81
83
  # endpoint.
@@ -474,7 +476,8 @@ module Orb
474
476
  sig { returns(T::Boolean) }
475
477
  attr_accessor :will_auto_issue
476
478
 
477
- # #InvoiceApiResourceWithoutLineItems
479
+ # An invoice without its line items, subtotal, discounts, minimums or maximums.
480
+ # Fetch the invoice for those.
478
481
  sig do
479
482
  params(
480
483
  id: String,
@@ -20,7 +20,8 @@ module Orb
20
20
  sig { returns(Time) }
21
21
  attr_accessor :created_at
22
22
 
23
- # #InvoiceApiResourceWithoutLineItems
23
+ # An invoice without its line items, subtotal, discounts, minimums or maximums.
24
+ # Fetch the invoice for those.
24
25
  sig do
25
26
  returns(
26
27
  Orb::Webhooks::InvoicePaymentFailedStandardWebhookEvent::Invoice
@@ -89,7 +90,8 @@ module Orb
89
90
  id:,
90
91
  # The time at which this event was created, to the second.
91
92
  created_at:,
92
- # #InvoiceApiResourceWithoutLineItems
93
+ # An invoice without its line items, subtotal, discounts, minimums or maximums.
94
+ # Fetch the invoice for those.
93
95
  invoice:,
94
96
  # The serialization style this payload was rendered in, as configured on the
95
97
  # endpoint.
@@ -489,7 +491,8 @@ module Orb
489
491
  sig { returns(T::Boolean) }
490
492
  attr_accessor :will_auto_issue
491
493
 
492
- # #InvoiceApiResourceWithoutLineItems
494
+ # An invoice without its line items, subtotal, discounts, minimums or maximums.
495
+ # Fetch the invoice for those.
493
496
  sig do
494
497
  params(
495
498
  id: String,
@@ -20,7 +20,8 @@ module Orb
20
20
  sig { returns(Time) }
21
21
  attr_accessor :created_at
22
22
 
23
- # #InvoiceApiResourceWithoutLineItems
23
+ # An invoice without its line items, subtotal, discounts, minimums or maximums.
24
+ # Fetch the invoice for those.
24
25
  sig do
25
26
  returns(
26
27
  Orb::Webhooks::InvoicePaymentProcessingStandardWebhookEvent::Invoice
@@ -88,7 +89,8 @@ module Orb
88
89
  id:,
89
90
  # The time at which this event was created, to the second.
90
91
  created_at:,
91
- # #InvoiceApiResourceWithoutLineItems
92
+ # An invoice without its line items, subtotal, discounts, minimums or maximums.
93
+ # Fetch the invoice for those.
92
94
  invoice:,
93
95
  # The serialization style this payload was rendered in, as configured on the
94
96
  # endpoint.
@@ -488,7 +490,8 @@ module Orb
488
490
  sig { returns(T::Boolean) }
489
491
  attr_accessor :will_auto_issue
490
492
 
491
- # #InvoiceApiResourceWithoutLineItems
493
+ # An invoice without its line items, subtotal, discounts, minimums or maximums.
494
+ # Fetch the invoice for those.
492
495
  sig do
493
496
  params(
494
497
  id: String,
@@ -20,7 +20,8 @@ module Orb
20
20
  sig { returns(Time) }
21
21
  attr_accessor :created_at
22
22
 
23
- # #InvoiceApiResourceWithoutLineItems
23
+ # An invoice without its line items, subtotal, discounts, minimums or maximums.
24
+ # Fetch the invoice for those.
24
25
  sig do
25
26
  returns(
26
27
  Orb::Webhooks::InvoicePaymentSucceededStandardWebhookEvent::Invoice
@@ -90,7 +91,8 @@ module Orb
90
91
  id:,
91
92
  # The time at which this event was created, to the second.
92
93
  created_at:,
93
- # #InvoiceApiResourceWithoutLineItems
94
+ # An invoice without its line items, subtotal, discounts, minimums or maximums.
95
+ # Fetch the invoice for those.
94
96
  invoice:,
95
97
  # The serialization style this payload was rendered in, as configured on the
96
98
  # endpoint.
@@ -491,7 +493,8 @@ module Orb
491
493
  sig { returns(T::Boolean) }
492
494
  attr_accessor :will_auto_issue
493
495
 
494
- # #InvoiceApiResourceWithoutLineItems
496
+ # An invoice without its line items, subtotal, discounts, minimums or maximums.
497
+ # Fetch the invoice for those.
495
498
  sig do
496
499
  params(
497
500
  id: String,
@@ -20,7 +20,8 @@ module Orb
20
20
  sig { returns(Time) }
21
21
  attr_accessor :created_at
22
22
 
23
- # #InvoiceApiResourceWithoutLineItems
23
+ # An invoice without its line items, subtotal, discounts, minimums or maximums.
24
+ # Fetch the invoice for those.
24
25
  sig do
25
26
  returns(Orb::Webhooks::InvoiceSyncFailedStandardWebhookEvent::Invoice)
26
27
  end
@@ -86,7 +87,8 @@ module Orb
86
87
  id:,
87
88
  # The time at which this event was created, to the second.
88
89
  created_at:,
89
- # #InvoiceApiResourceWithoutLineItems
90
+ # An invoice without its line items, subtotal, discounts, minimums or maximums.
91
+ # Fetch the invoice for those.
90
92
  invoice:,
91
93
  # The serialization style this payload was rendered in, as configured on the
92
94
  # endpoint.
@@ -486,7 +488,8 @@ module Orb
486
488
  sig { returns(T::Boolean) }
487
489
  attr_accessor :will_auto_issue
488
490
 
489
- # #InvoiceApiResourceWithoutLineItems
491
+ # An invoice without its line items, subtotal, discounts, minimums or maximums.
492
+ # Fetch the invoice for those.
490
493
  sig do
491
494
  params(
492
495
  id: String,
@@ -20,7 +20,8 @@ module Orb
20
20
  sig { returns(Time) }
21
21
  attr_accessor :created_at
22
22
 
23
- # #InvoiceApiResourceWithoutLineItems
23
+ # An invoice without its line items, subtotal, discounts, minimums or maximums.
24
+ # Fetch the invoice for those.
24
25
  sig do
25
26
  returns(
26
27
  Orb::Webhooks::InvoiceSyncSucceededStandardWebhookEvent::Invoice
@@ -88,7 +89,8 @@ module Orb
88
89
  id:,
89
90
  # The time at which this event was created, to the second.
90
91
  created_at:,
91
- # #InvoiceApiResourceWithoutLineItems
92
+ # An invoice without its line items, subtotal, discounts, minimums or maximums.
93
+ # Fetch the invoice for those.
92
94
  invoice:,
93
95
  # The serialization style this payload was rendered in, as configured on the
94
96
  # endpoint.
@@ -488,7 +490,8 @@ module Orb
488
490
  sig { returns(T::Boolean) }
489
491
  attr_accessor :will_auto_issue
490
492
 
491
- # #InvoiceApiResourceWithoutLineItems
493
+ # An invoice without its line items, subtotal, discounts, minimums or maximums.
494
+ # Fetch the invoice for those.
492
495
  sig do
493
496
  params(
494
497
  id: String,
@@ -20,7 +20,8 @@ module Orb
20
20
  sig { returns(Time) }
21
21
  attr_accessor :created_at
22
22
 
23
- # #InvoiceApiResourceWithoutLineItems
23
+ # An invoice without its line items, subtotal, discounts, minimums or maximums.
24
+ # Fetch the invoice for those.
24
25
  sig do
25
26
  returns(
26
27
  Orb::Webhooks::InvoiceUndoMarkAsPaidStandardWebhookEvent::Invoice
@@ -75,7 +76,8 @@ module Orb
75
76
  id:,
76
77
  # The time at which this event was created, to the second.
77
78
  created_at:,
78
- # #InvoiceApiResourceWithoutLineItems
79
+ # An invoice without its line items, subtotal, discounts, minimums or maximums.
80
+ # Fetch the invoice for those.
79
81
  invoice:,
80
82
  # The serialization style this payload was rendered in, as configured on the
81
83
  # endpoint.
@@ -474,7 +476,8 @@ module Orb
474
476
  sig { returns(T::Boolean) }
475
477
  attr_accessor :will_auto_issue
476
478
 
477
- # #InvoiceApiResourceWithoutLineItems
479
+ # An invoice without its line items, subtotal, discounts, minimums or maximums.
480
+ # Fetch the invoice for those.
478
481
  sig do
479
482
  params(
480
483
  id: String,
@@ -35,7 +35,8 @@ module Orb
35
35
  sig { returns(Time) }
36
36
  attr_accessor :created_at
37
37
 
38
- # #InvoiceApiResourceWithoutLineItems
38
+ # An invoice without its line items, subtotal, discounts, minimums or maximums.
39
+ # Fetch the invoice for those.
39
40
  sig do
40
41
  returns(
41
42
  Orb::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent::Invoice
@@ -106,7 +107,8 @@ module Orb
106
107
  accounting_sync_record:,
107
108
  # The time at which this event was created, to the second.
108
109
  created_at:,
109
- # #InvoiceApiResourceWithoutLineItems
110
+ # An invoice without its line items, subtotal, discounts, minimums or maximums.
111
+ # Fetch the invoice for those.
110
112
  invoice:,
111
113
  # The serialization style this payload was rendered in, as configured on the
112
114
  # endpoint.
@@ -653,7 +655,8 @@ module Orb
653
655
  sig { returns(T::Boolean) }
654
656
  attr_accessor :will_auto_issue
655
657
 
656
- # #InvoiceApiResourceWithoutLineItems
658
+ # An invoice without its line items, subtotal, discounts, minimums or maximums.
659
+ # Fetch the invoice for those.
657
660
  sig do
658
661
  params(
659
662
  id: String,
@@ -35,7 +35,8 @@ module Orb
35
35
  sig { returns(Time) }
36
36
  attr_accessor :created_at
37
37
 
38
- # #InvoiceApiResourceWithoutLineItems
38
+ # An invoice without its line items, subtotal, discounts, minimums or maximums.
39
+ # Fetch the invoice for those.
39
40
  sig do
40
41
  returns(
41
42
  Orb::Webhooks::SalesOrderAccountingSyncSucceededStandardWebhookEvent::Invoice
@@ -106,7 +107,8 @@ module Orb
106
107
  accounting_sync_record:,
107
108
  # The time at which this event was created, to the second.
108
109
  created_at:,
109
- # #InvoiceApiResourceWithoutLineItems
110
+ # An invoice without its line items, subtotal, discounts, minimums or maximums.
111
+ # Fetch the invoice for those.
110
112
  invoice:,
111
113
  # The serialization style this payload was rendered in, as configured on the
112
114
  # endpoint.
@@ -653,7 +655,8 @@ module Orb
653
655
  sig { returns(T::Boolean) }
654
656
  attr_accessor :will_auto_issue
655
657
 
656
- # #InvoiceApiResourceWithoutLineItems
658
+ # An invoice without its line items, subtotal, discounts, minimums or maximums.
659
+ # Fetch the invoice for those.
657
660
  sig do
658
661
  params(
659
662
  id: String,
@@ -59,9 +59,9 @@ module Orb
59
59
  end
60
60
  attr_writer :properties
61
61
 
62
- # The subscription in a standard webhook payload: the fields readable without
63
- # to_subscription_params(), which every interval, billing period and plan phase
64
- # depends on.
62
+ # The subscription in a standard webhook payload: its own fields, with its plan
63
+ # and customer as references. Fetch the subscription for its price intervals,
64
+ # billing periods, plan phases and other derived fields.
65
65
  sig do
66
66
  returns(
67
67
  Orb::Webhooks::SubscriptionAccountingSyncFailedStandardWebhookEvent::Subscription
@@ -112,9 +112,9 @@ module Orb
112
112
  # endpoint.
113
113
  payload_style:,
114
114
  properties:,
115
- # The subscription in a standard webhook payload: the fields readable without
116
- # to_subscription_params(), which every interval, billing period and plan phase
117
- # depends on.
115
+ # The subscription in a standard webhook payload: its own fields, with its plan
116
+ # and customer as references. Fetch the subscription for its price intervals,
117
+ # billing periods, plan phases and other derived fields.
118
118
  subscription:,
119
119
  # The event this payload describes.
120
120
  type:
@@ -421,9 +421,9 @@ module Orb
421
421
  end
422
422
  attr_accessor :status
423
423
 
424
- # The subscription in a standard webhook payload: the fields readable without
425
- # to_subscription_params(), which every interval, billing period and plan phase
426
- # depends on.
424
+ # The subscription in a standard webhook payload: its own fields, with its plan
425
+ # and customer as references. Fetch the subscription for its price intervals,
426
+ # billing periods, plan phases and other derived fields.
427
427
  sig do
428
428
  params(
429
429
  id: String,
@@ -59,9 +59,9 @@ module Orb
59
59
  end
60
60
  attr_writer :properties
61
61
 
62
- # The subscription in a standard webhook payload: the fields readable without
63
- # to_subscription_params(), which every interval, billing period and plan phase
64
- # depends on.
62
+ # The subscription in a standard webhook payload: its own fields, with its plan
63
+ # and customer as references. Fetch the subscription for its price intervals,
64
+ # billing periods, plan phases and other derived fields.
65
65
  sig do
66
66
  returns(
67
67
  Orb::Webhooks::SubscriptionAccountingSyncSucceededStandardWebhookEvent::Subscription
@@ -112,9 +112,9 @@ module Orb
112
112
  # endpoint.
113
113
  payload_style:,
114
114
  properties:,
115
- # The subscription in a standard webhook payload: the fields readable without
116
- # to_subscription_params(), which every interval, billing period and plan phase
117
- # depends on.
115
+ # The subscription in a standard webhook payload: its own fields, with its plan
116
+ # and customer as references. Fetch the subscription for its price intervals,
117
+ # billing periods, plan phases and other derived fields.
118
118
  subscription:,
119
119
  # The event this payload describes.
120
120
  type:
@@ -410,9 +410,9 @@ module Orb
410
410
  end
411
411
  attr_accessor :status
412
412
 
413
- # The subscription in a standard webhook payload: the fields readable without
414
- # to_subscription_params(), which every interval, billing period and plan phase
415
- # depends on.
413
+ # The subscription in a standard webhook payload: its own fields, with its plan
414
+ # and customer as references. Fetch the subscription for its price intervals,
415
+ # billing periods, plan phases and other derived fields.
416
416
  sig do
417
417
  params(
418
418
  id: String,
@@ -46,10 +46,8 @@ module Orb
46
46
  end
47
47
  attr_writer :properties
48
48
 
49
- # A lightweight subscription representation for webhook payloads.
50
- #
51
- # This avoids the expensive to_subscription_params() call required for full
52
- # serialization.
49
+ # The subscription in a license or grouped cost webhook payload: its status,
50
+ # dates, plan and customer.
53
51
  sig do
54
52
  returns(
55
53
  Orb::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Subscription
@@ -99,10 +97,8 @@ module Orb
99
97
  # Sent when the system disables an alert on its own, currently for
100
98
  # cardinality-limit enforcement on grouped cost alerts.
101
99
  properties:,
102
- # A lightweight subscription representation for webhook payloads.
103
- #
104
- # This avoids the expensive to_subscription_params() call required for full
105
- # serialization.
100
+ # The subscription in a license or grouped cost webhook payload: its status,
101
+ # dates, plan and customer.
106
102
  subscription:,
107
103
  # The event this payload describes.
108
104
  type:
@@ -1136,10 +1132,8 @@ module Orb
1136
1132
  end
1137
1133
  attr_accessor :status
1138
1134
 
1139
- # A lightweight subscription representation for webhook payloads.
1140
- #
1141
- # This avoids the expensive to_subscription_params() call required for full
1142
- # serialization.
1135
+ # The subscription in a license or grouped cost webhook payload: its status,
1136
+ # dates, plan and customer.
1143
1137
  sig do
1144
1138
  params(
1145
1139
  id: String,
@@ -44,9 +44,9 @@ module Orb
44
44
  end
45
45
  attr_writer :properties
46
46
 
47
- # The subscription in a standard webhook payload: the fields readable without
48
- # to_subscription_params(), which every interval, billing period and plan phase
49
- # depends on.
47
+ # The subscription in a standard webhook payload: its own fields, with its plan
48
+ # and customer as references. Fetch the subscription for its price intervals,
49
+ # billing periods, plan phases and other derived fields.
50
50
  sig do
51
51
  returns(
52
52
  Orb::Webhooks::SubscriptionCancellationScheduledStandardWebhookEvent::Subscription
@@ -94,9 +94,9 @@ module Orb
94
94
  # endpoint.
95
95
  payload_style:,
96
96
  properties:,
97
- # The subscription in a standard webhook payload: the fields readable without
98
- # to_subscription_params(), which every interval, billing period and plan phase
99
- # depends on.
97
+ # The subscription in a standard webhook payload: its own fields, with its plan
98
+ # and customer as references. Fetch the subscription for its price intervals,
99
+ # billing periods, plan phases and other derived fields.
100
100
  subscription:,
101
101
  # The event this payload describes.
102
102
  type:
@@ -245,9 +245,9 @@ module Orb
245
245
  end
246
246
  attr_accessor :status
247
247
 
248
- # The subscription in a standard webhook payload: the fields readable without
249
- # to_subscription_params(), which every interval, billing period and plan phase
250
- # depends on.
248
+ # The subscription in a standard webhook payload: its own fields, with its plan
249
+ # and customer as references. Fetch the subscription for its price intervals,
250
+ # billing periods, plan phases and other derived fields.
251
251
  sig do
252
252
  params(
253
253
  id: String,
@@ -44,9 +44,9 @@ module Orb
44
44
  end
45
45
  attr_writer :properties
46
46
 
47
- # The subscription in a standard webhook payload: the fields readable without
48
- # to_subscription_params(), which every interval, billing period and plan phase
49
- # depends on.
47
+ # The subscription in a standard webhook payload: its own fields, with its plan
48
+ # and customer as references. Fetch the subscription for its price intervals,
49
+ # billing periods, plan phases and other derived fields.
50
50
  sig do
51
51
  returns(
52
52
  Orb::Webhooks::SubscriptionCancellationUnscheduledStandardWebhookEvent::Subscription
@@ -94,9 +94,9 @@ module Orb
94
94
  # endpoint.
95
95
  payload_style:,
96
96
  properties:,
97
- # The subscription in a standard webhook payload: the fields readable without
98
- # to_subscription_params(), which every interval, billing period and plan phase
99
- # depends on.
97
+ # The subscription in a standard webhook payload: its own fields, with its plan
98
+ # and customer as references. Fetch the subscription for its price intervals,
99
+ # billing periods, plan phases and other derived fields.
100
100
  subscription:,
101
101
  # The event this payload describes.
102
102
  type:
@@ -247,9 +247,9 @@ module Orb
247
247
  end
248
248
  attr_accessor :status
249
249
 
250
- # The subscription in a standard webhook payload: the fields readable without
251
- # to_subscription_params(), which every interval, billing period and plan phase
252
- # depends on.
250
+ # The subscription in a standard webhook payload: its own fields, with its plan
251
+ # and customer as references. Fetch the subscription for its price intervals,
252
+ # billing periods, plan phases and other derived fields.
253
253
  sig do
254
254
  params(
255
255
  id: String,
@@ -44,9 +44,9 @@ module Orb
44
44
  end
45
45
  attr_writer :properties
46
46
 
47
- # The subscription in a standard webhook payload: the fields readable without
48
- # to_subscription_params(), which every interval, billing period and plan phase
49
- # depends on.
47
+ # The subscription in a standard webhook payload: its own fields, with its plan
48
+ # and customer as references. Fetch the subscription for its price intervals,
49
+ # billing periods, plan phases and other derived fields.
50
50
  sig do
51
51
  returns(
52
52
  Orb::Webhooks::SubscriptionCostExceededStandardWebhookEvent::Subscription
@@ -94,9 +94,9 @@ module Orb
94
94
  # endpoint.
95
95
  payload_style:,
96
96
  properties:,
97
- # The subscription in a standard webhook payload: the fields readable without
98
- # to_subscription_params(), which every interval, billing period and plan phase
99
- # depends on.
97
+ # The subscription in a standard webhook payload: its own fields, with its plan
98
+ # and customer as references. Fetch the subscription for its price intervals,
99
+ # billing periods, plan phases and other derived fields.
100
100
  subscription:,
101
101
  # The event this payload describes.
102
102
  type:
@@ -1110,9 +1110,9 @@ module Orb
1110
1110
  end
1111
1111
  attr_accessor :status
1112
1112
 
1113
- # The subscription in a standard webhook payload: the fields readable without
1114
- # to_subscription_params(), which every interval, billing period and plan phase
1115
- # depends on.
1113
+ # The subscription in a standard webhook payload: its own fields, with its plan
1114
+ # and customer as references. Fetch the subscription for its price intervals,
1115
+ # billing periods, plan phases and other derived fields.
1116
1116
  sig do
1117
1117
  params(
1118
1118
  id: String,
@@ -32,9 +32,9 @@ module Orb
32
32
  sig { returns(T.anything) }
33
33
  attr_accessor :properties
34
34
 
35
- # The subscription in a standard webhook payload: the fields readable without
36
- # to_subscription_params(), which every interval, billing period and plan phase
37
- # depends on.
35
+ # The subscription in a standard webhook payload: its own fields, with its plan
36
+ # and customer as references. Fetch the subscription for its price intervals,
37
+ # billing periods, plan phases and other derived fields.
38
38
  sig do
39
39
  returns(
40
40
  Orb::Webhooks::SubscriptionCreatedStandardWebhookEvent::Subscription
@@ -81,9 +81,9 @@ module Orb
81
81
  # endpoint.
82
82
  payload_style:,
83
83
  properties:,
84
- # The subscription in a standard webhook payload: the fields readable without
85
- # to_subscription_params(), which every interval, billing period and plan phase
86
- # depends on.
84
+ # The subscription in a standard webhook payload: its own fields, with its plan
85
+ # and customer as references. Fetch the subscription for its price intervals,
86
+ # billing periods, plan phases and other derived fields.
87
87
  subscription:,
88
88
  # The event this payload describes.
89
89
  type:
@@ -210,9 +210,9 @@ module Orb
210
210
  end
211
211
  attr_accessor :status
212
212
 
213
- # The subscription in a standard webhook payload: the fields readable without
214
- # to_subscription_params(), which every interval, billing period and plan phase
215
- # depends on.
213
+ # The subscription in a standard webhook payload: its own fields, with its plan
214
+ # and customer as references. Fetch the subscription for its price intervals,
215
+ # billing periods, plan phases and other derived fields.
216
216
  sig do
217
217
  params(
218
218
  id: String,
@@ -44,9 +44,9 @@ module Orb
44
44
  end
45
45
  attr_writer :properties
46
46
 
47
- # The subscription in a standard webhook payload: the fields readable without
48
- # to_subscription_params(), which every interval, billing period and plan phase
49
- # depends on.
47
+ # The subscription in a standard webhook payload: its own fields, with its plan
48
+ # and customer as references. Fetch the subscription for its price intervals,
49
+ # billing periods, plan phases and other derived fields.
50
50
  sig do
51
51
  returns(
52
52
  Orb::Webhooks::SubscriptionEditedStandardWebhookEvent::Subscription
@@ -94,9 +94,9 @@ module Orb
94
94
  # endpoint.
95
95
  payload_style:,
96
96
  properties:,
97
- # The subscription in a standard webhook payload: the fields readable without
98
- # to_subscription_params(), which every interval, billing period and plan phase
99
- # depends on.
97
+ # The subscription in a standard webhook payload: its own fields, with its plan
98
+ # and customer as references. Fetch the subscription for its price intervals,
99
+ # billing periods, plan phases and other derived fields.
100
100
  subscription:,
101
101
  # The event this payload describes.
102
102
  type:
@@ -332,9 +332,9 @@ module Orb
332
332
  end
333
333
  attr_accessor :status
334
334
 
335
- # The subscription in a standard webhook payload: the fields readable without
336
- # to_subscription_params(), which every interval, billing period and plan phase
337
- # depends on.
335
+ # The subscription in a standard webhook payload: its own fields, with its plan
336
+ # and customer as references. Fetch the subscription for its price intervals,
337
+ # billing periods, plan phases and other derived fields.
338
338
  sig do
339
339
  params(
340
340
  id: String,