orb-billing 1.46.0 → 1.48.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 (160) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +24 -1
  3. data/README.md +1 -1
  4. data/lib/orb/models/credit_block_update_params.rb +34 -0
  5. data/lib/orb/models/credit_block_update_response.rb +332 -0
  6. data/lib/orb/models/invoice_issue_summary_response.rb +2 -1
  7. data/lib/orb/models/invoice_issued_summary_webhook_event.rb +5 -3
  8. data/lib/orb/models/invoice_list_summary_response.rb +2 -1
  9. data/lib/orb/models/metric_archive_params.rb +20 -0
  10. data/lib/orb/models/metric_list_params.rb +21 -1
  11. data/lib/orb/models/metric_unarchive_params.rb +20 -0
  12. data/lib/orb/models/metric_update_params.rb +17 -1
  13. data/lib/orb/models/plan_update_params.rb +9 -1
  14. data/lib/orb/models/plans/external_plan_id_update_params.rb +9 -1
  15. data/lib/orb/models/subscription_alert_disabled_webhook_event.rb +5 -9
  16. data/lib/orb/models/subscription_grouped_cost_exceeded_webhook_event.rb +5 -9
  17. data/lib/orb/models/subscription_invoicing_threshold_exceeded_webhook_event.rb +5 -9
  18. data/lib/orb/models/subscription_license_allocation_reset_webhook_event.rb +5 -9
  19. data/lib/orb/models/subscription_license_balance_threshold_reached_webhook_event.rb +5 -9
  20. data/lib/orb/models/webhook_endpoint.rb +28 -1
  21. data/lib/orb/models/webhook_endpoint_create_params.rb +22 -1
  22. data/lib/orb/models/webhook_endpoint_update_params.rb +22 -1
  23. data/lib/orb/models/webhook_endpoint_with_secret.rb +28 -1
  24. data/lib/orb/models/webhooks/invoice_accounting_sync_failed_standard_webhook_event.rb +5 -3
  25. data/lib/orb/models/webhooks/invoice_accounting_sync_succeeded_standard_webhook_event.rb +5 -3
  26. data/lib/orb/models/webhooks/invoice_dunning_schedule_created_standard_webhook_event.rb +5 -3
  27. data/lib/orb/models/webhooks/invoice_dunning_schedule_ended_standard_webhook_event.rb +5 -3
  28. data/lib/orb/models/webhooks/invoice_dunning_schedule_reset_standard_webhook_event.rb +5 -3
  29. data/lib/orb/models/webhooks/invoice_dunning_schedule_step_executed_standard_webhook_event.rb +5 -3
  30. data/lib/orb/models/webhooks/invoice_edited_standard_webhook_event.rb +5 -3
  31. data/lib/orb/models/webhooks/invoice_issue_failed_standard_webhook_event.rb +5 -3
  32. data/lib/orb/models/webhooks/invoice_issued_standard_webhook_event.rb +5 -3
  33. data/lib/orb/models/webhooks/invoice_issued_summary_standard_webhook_event.rb +5 -3
  34. data/lib/orb/models/webhooks/invoice_manually_marked_as_paid_standard_webhook_event.rb +5 -3
  35. data/lib/orb/models/webhooks/invoice_manually_marked_as_void_standard_webhook_event.rb +5 -3
  36. data/lib/orb/models/webhooks/invoice_payment_failed_standard_webhook_event.rb +5 -3
  37. data/lib/orb/models/webhooks/invoice_payment_processing_standard_webhook_event.rb +5 -3
  38. data/lib/orb/models/webhooks/invoice_payment_succeeded_standard_webhook_event.rb +5 -3
  39. data/lib/orb/models/webhooks/invoice_sync_failed_standard_webhook_event.rb +5 -3
  40. data/lib/orb/models/webhooks/invoice_sync_succeeded_standard_webhook_event.rb +5 -3
  41. data/lib/orb/models/webhooks/invoice_undo_mark_as_paid_standard_webhook_event.rb +5 -3
  42. data/lib/orb/models/webhooks/sales_order_accounting_sync_failed_standard_webhook_event.rb +5 -3
  43. data/lib/orb/models/webhooks/sales_order_accounting_sync_succeeded_standard_webhook_event.rb +5 -3
  44. data/lib/orb/models/webhooks/subscription_accounting_sync_failed_standard_webhook_event.rb +9 -7
  45. data/lib/orb/models/webhooks/subscription_accounting_sync_succeeded_standard_webhook_event.rb +9 -7
  46. data/lib/orb/models/webhooks/subscription_alert_disabled_standard_webhook_event.rb +5 -9
  47. data/lib/orb/models/webhooks/subscription_cancellation_scheduled_standard_webhook_event.rb +9 -7
  48. data/lib/orb/models/webhooks/subscription_cancellation_unscheduled_standard_webhook_event.rb +9 -7
  49. data/lib/orb/models/webhooks/subscription_cost_exceeded_standard_webhook_event.rb +9 -7
  50. data/lib/orb/models/webhooks/subscription_created_standard_webhook_event.rb +9 -7
  51. data/lib/orb/models/webhooks/subscription_edited_standard_webhook_event.rb +9 -7
  52. data/lib/orb/models/webhooks/subscription_ended_standard_webhook_event.rb +9 -7
  53. data/lib/orb/models/webhooks/subscription_fixed_fee_quantity_updated_standard_webhook_event.rb +9 -7
  54. data/lib/orb/models/webhooks/subscription_grouped_cost_exceeded_standard_webhook_event.rb +5 -9
  55. data/lib/orb/models/webhooks/subscription_invoicing_threshold_exceeded_standard_webhook_event.rb +5 -9
  56. data/lib/orb/models/webhooks/subscription_license_allocation_reset_standard_webhook_event.rb +5 -9
  57. data/lib/orb/models/webhooks/subscription_license_balance_threshold_reached_standard_webhook_event.rb +5 -9
  58. data/lib/orb/models/webhooks/subscription_plan_change_scheduled_standard_webhook_event.rb +9 -7
  59. data/lib/orb/models/webhooks/subscription_plan_changed_standard_webhook_event.rb +9 -7
  60. data/lib/orb/models/webhooks/subscription_plan_version_change_scheduled_standard_webhook_event.rb +9 -7
  61. data/lib/orb/models/webhooks/subscription_plan_version_changed_standard_webhook_event.rb +9 -7
  62. data/lib/orb/models/webhooks/subscription_spend_exceeded_standard_webhook_event.rb +9 -7
  63. data/lib/orb/models/webhooks/subscription_started_standard_webhook_event.rb +9 -7
  64. data/lib/orb/models/webhooks/subscription_trial_ended_standard_webhook_event.rb +9 -7
  65. data/lib/orb/models/webhooks/subscription_usage_exceeded_standard_webhook_event.rb +9 -7
  66. data/lib/orb/models.rb +6 -0
  67. data/lib/orb/resources/credit_blocks.rb +35 -0
  68. data/lib/orb/resources/metrics.rb +61 -5
  69. data/lib/orb/resources/plans/external_plan_id.rb +6 -3
  70. data/lib/orb/resources/plans.rb +6 -3
  71. data/lib/orb/resources/webhook_endpoints.rb +6 -2
  72. data/lib/orb/version.rb +1 -1
  73. data/lib/orb.rb +4 -0
  74. data/rbi/orb/models/credit_block_update_params.rbi +53 -0
  75. data/rbi/orb/models/credit_block_update_response.rbi +693 -0
  76. data/rbi/orb/models/invoice_issue_summary_response.rbi +2 -1
  77. data/rbi/orb/models/invoice_issued_summary_webhook_event.rbi +6 -3
  78. data/rbi/orb/models/invoice_list_summary_response.rbi +2 -1
  79. data/rbi/orb/models/metric_archive_params.rbi +33 -0
  80. data/rbi/orb/models/metric_list_params.rbi +29 -0
  81. data/rbi/orb/models/metric_unarchive_params.rbi +35 -0
  82. data/rbi/orb/models/metric_update_params.rbi +16 -0
  83. data/rbi/orb/models/plan_update_params.rbi +8 -0
  84. data/rbi/orb/models/plans/external_plan_id_update_params.rbi +8 -0
  85. data/rbi/orb/models/subscription_alert_disabled_webhook_event.rbi +6 -12
  86. data/rbi/orb/models/subscription_grouped_cost_exceeded_webhook_event.rbi +6 -12
  87. data/rbi/orb/models/subscription_invoicing_threshold_exceeded_webhook_event.rbi +6 -12
  88. data/rbi/orb/models/subscription_license_allocation_reset_webhook_event.rbi +6 -12
  89. data/rbi/orb/models/subscription_license_balance_threshold_reached_webhook_event.rbi +6 -12
  90. data/rbi/orb/models/webhook_endpoint.rbi +39 -0
  91. data/rbi/orb/models/webhook_endpoint_create_params.rbi +51 -0
  92. data/rbi/orb/models/webhook_endpoint_update_params.rbi +51 -0
  93. data/rbi/orb/models/webhook_endpoint_with_secret.rbi +50 -0
  94. data/rbi/orb/models/webhooks/invoice_accounting_sync_failed_standard_webhook_event.rbi +6 -3
  95. data/rbi/orb/models/webhooks/invoice_accounting_sync_succeeded_standard_webhook_event.rbi +6 -3
  96. data/rbi/orb/models/webhooks/invoice_dunning_schedule_created_standard_webhook_event.rbi +6 -3
  97. data/rbi/orb/models/webhooks/invoice_dunning_schedule_ended_standard_webhook_event.rbi +6 -3
  98. data/rbi/orb/models/webhooks/invoice_dunning_schedule_reset_standard_webhook_event.rbi +6 -3
  99. data/rbi/orb/models/webhooks/invoice_dunning_schedule_step_executed_standard_webhook_event.rbi +6 -3
  100. data/rbi/orb/models/webhooks/invoice_edited_standard_webhook_event.rbi +6 -3
  101. data/rbi/orb/models/webhooks/invoice_issue_failed_standard_webhook_event.rbi +6 -3
  102. data/rbi/orb/models/webhooks/invoice_issued_standard_webhook_event.rbi +6 -3
  103. data/rbi/orb/models/webhooks/invoice_issued_summary_standard_webhook_event.rbi +6 -3
  104. data/rbi/orb/models/webhooks/invoice_manually_marked_as_paid_standard_webhook_event.rbi +6 -3
  105. data/rbi/orb/models/webhooks/invoice_manually_marked_as_void_standard_webhook_event.rbi +6 -3
  106. data/rbi/orb/models/webhooks/invoice_payment_failed_standard_webhook_event.rbi +6 -3
  107. data/rbi/orb/models/webhooks/invoice_payment_processing_standard_webhook_event.rbi +6 -3
  108. data/rbi/orb/models/webhooks/invoice_payment_succeeded_standard_webhook_event.rbi +6 -3
  109. data/rbi/orb/models/webhooks/invoice_sync_failed_standard_webhook_event.rbi +6 -3
  110. data/rbi/orb/models/webhooks/invoice_sync_succeeded_standard_webhook_event.rbi +6 -3
  111. data/rbi/orb/models/webhooks/invoice_undo_mark_as_paid_standard_webhook_event.rbi +6 -3
  112. data/rbi/orb/models/webhooks/sales_order_accounting_sync_failed_standard_webhook_event.rbi +6 -3
  113. data/rbi/orb/models/webhooks/sales_order_accounting_sync_succeeded_standard_webhook_event.rbi +6 -3
  114. data/rbi/orb/models/webhooks/subscription_accounting_sync_failed_standard_webhook_event.rbi +12 -9
  115. data/rbi/orb/models/webhooks/subscription_accounting_sync_succeeded_standard_webhook_event.rbi +12 -9
  116. data/rbi/orb/models/webhooks/subscription_alert_disabled_standard_webhook_event.rbi +6 -12
  117. data/rbi/orb/models/webhooks/subscription_cancellation_scheduled_standard_webhook_event.rbi +12 -9
  118. data/rbi/orb/models/webhooks/subscription_cancellation_unscheduled_standard_webhook_event.rbi +12 -9
  119. data/rbi/orb/models/webhooks/subscription_cost_exceeded_standard_webhook_event.rbi +12 -9
  120. data/rbi/orb/models/webhooks/subscription_created_standard_webhook_event.rbi +12 -9
  121. data/rbi/orb/models/webhooks/subscription_edited_standard_webhook_event.rbi +12 -9
  122. data/rbi/orb/models/webhooks/subscription_ended_standard_webhook_event.rbi +12 -9
  123. data/rbi/orb/models/webhooks/subscription_fixed_fee_quantity_updated_standard_webhook_event.rbi +12 -9
  124. data/rbi/orb/models/webhooks/subscription_grouped_cost_exceeded_standard_webhook_event.rbi +6 -12
  125. data/rbi/orb/models/webhooks/subscription_invoicing_threshold_exceeded_standard_webhook_event.rbi +6 -12
  126. data/rbi/orb/models/webhooks/subscription_license_allocation_reset_standard_webhook_event.rbi +6 -12
  127. data/rbi/orb/models/webhooks/subscription_license_balance_threshold_reached_standard_webhook_event.rbi +6 -12
  128. data/rbi/orb/models/webhooks/subscription_plan_change_scheduled_standard_webhook_event.rbi +12 -9
  129. data/rbi/orb/models/webhooks/subscription_plan_changed_standard_webhook_event.rbi +12 -9
  130. data/rbi/orb/models/webhooks/subscription_plan_version_change_scheduled_standard_webhook_event.rbi +12 -9
  131. data/rbi/orb/models/webhooks/subscription_plan_version_changed_standard_webhook_event.rbi +12 -9
  132. data/rbi/orb/models/webhooks/subscription_spend_exceeded_standard_webhook_event.rbi +12 -9
  133. data/rbi/orb/models/webhooks/subscription_started_standard_webhook_event.rbi +12 -9
  134. data/rbi/orb/models/webhooks/subscription_trial_ended_standard_webhook_event.rbi +12 -9
  135. data/rbi/orb/models/webhooks/subscription_usage_exceeded_standard_webhook_event.rbi +12 -9
  136. data/rbi/orb/models.rbi +6 -0
  137. data/rbi/orb/resources/credit_blocks.rbi +26 -0
  138. data/rbi/orb/resources/metrics.rbi +44 -3
  139. data/rbi/orb/resources/plans/external_plan_id.rbi +6 -2
  140. data/rbi/orb/resources/plans.rbi +6 -2
  141. data/rbi/orb/resources/webhook_endpoints.rbi +10 -0
  142. data/sig/orb/models/credit_block_update_params.rbs +28 -0
  143. data/sig/orb/models/credit_block_update_response.rbs +263 -0
  144. data/sig/orb/models/metric_archive_params.rbs +23 -0
  145. data/sig/orb/models/metric_list_params.rbs +18 -1
  146. data/sig/orb/models/metric_unarchive_params.rbs +23 -0
  147. data/sig/orb/models/metric_update_params.rbs +14 -1
  148. data/sig/orb/models/plan_update_params.rbs +6 -1
  149. data/sig/orb/models/plans/external_plan_id_update_params.rbs +6 -1
  150. data/sig/orb/models/webhook_endpoint.rbs +16 -0
  151. data/sig/orb/models/webhook_endpoint_create_params.rbs +20 -1
  152. data/sig/orb/models/webhook_endpoint_update_params.rbs +16 -0
  153. data/sig/orb/models/webhook_endpoint_with_secret.rbs +16 -0
  154. data/sig/orb/models.rbs +6 -0
  155. data/sig/orb/resources/credit_blocks.rbs +6 -0
  156. data/sig/orb/resources/metrics.rbs +13 -0
  157. data/sig/orb/resources/plans/external_plan_id.rbs +1 -0
  158. data/sig/orb/resources/plans.rbs +1 -0
  159. data/sig/orb/resources/webhook_endpoints.rbs +2 -0
  160. metadata +13 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 20f90646d6a31280c787e98c2230430879ac97286b3525a99ec93718d65acaa8
4
- data.tar.gz: ee694d8c210aca4822fdbcf012971b45e75151e5be8ee69c5a9ac688befcd2ad
3
+ metadata.gz: 3a525b92a1a6f29957b2cb25a56d07bffb8e69a009852a1f2ca72132a2e2f531
4
+ data.tar.gz: 429829175519be27c097d4d1cc1079eb358bf57038303228085e85c9ddda4242
5
5
  SHA512:
6
- metadata.gz: 5491b87312196734c4aa3e51bb3f66ade075d0514e38eb8b39045d41cc0e648b1dc682a36821e015270bc8c0a1a7e678ace684fec718e4d58946d113ae14ae07
7
- data.tar.gz: 6b9852c9501a65ee75630c3729047116b0eba771d1b7d5b384387d2146ef7f740bab6b887162640a0ba4b14c31a12a9d80db60bd8129474295347431bc783d7e
6
+ metadata.gz: e89d1b03c858c4f8971a925951a800ccba1c58b072f791db95c732b216e8b507b7e9ced541a96c4a6be656c6f1f2ba9237b63a7c697fe8c67cd7757d9bc74a33
7
+ data.tar.gz: 5fcd2c53b737a529881de5d8391224ac614d71592c3e73a0857f56e7e9043996243155ddce23da4efe6b2e91c9fc2682b1267d055169b9eb75f92bf2cb13969c
data/CHANGELOG.md CHANGED
@@ -1,11 +1,34 @@
1
1
  # Changelog
2
2
 
3
+ ## [1.48.0](https://github.com/orbcorp/orb-ruby/compare/v1.47.0...v1.48.0) (2026-10-24)
4
+
5
+
6
+ ### Features
7
+
8
+ * **api:** add list endpoint for lightweight subscription summaries ([7640020](https://github.com/orbcorp/orb-ruby/commit/7640020cab2a3d03c569781bdb51af3ae504fc91))
9
+
10
+ ## [1.47.0](https://github.com/orbcorp/orb-ruby/compare/v1.46.0...v1.47.0) (2026-10-23)
11
+
12
+
13
+ ### Features
14
+
15
+ * **api:** Add customer credit balance summary endpoints ([86aae77](https://github.com/orbcorp/orb-ruby/commit/86aae7723d2ae70a7e2a2fa25e32d851e7e7063c))
16
+ * **api:** Add endpoint to update credit block metadata ([1d1a10b](https://github.com/orbcorp/orb-ruby/commit/1d1a10b91d5e9bd9b33140a0f5deb452ac8cb313))
17
+ * **api:** api update ([1d1a10b](https://github.com/orbcorp/orb-ruby/commit/1d1a10b91d5e9bd9b33140a0f5deb452ac8cb313))
18
+ * **api:** api update ([1d1a10b](https://github.com/orbcorp/orb-ruby/commit/1d1a10b91d5e9bd9b33140a0f5deb452ac8cb313))
19
+ * **api:** api update ([1d1a10b](https://github.com/orbcorp/orb-ruby/commit/1d1a10b91d5e9bd9b33140a0f5deb452ac8cb313))
20
+
21
+
22
+ ### Chores
23
+
24
+ * correct the standard webhook unwrap changelog entry ([#7](https://github.com/orbcorp/orb-ruby/issues/7)) ([637729f](https://github.com/orbcorp/orb-ruby/commit/637729fc02855e0599b70f4ce6c33a92e9ae1035))
25
+
3
26
  ## [1.46.0](https://github.com/orbcorp/orb-ruby/compare/v1.45.0...v1.46.0) (2026-10-22)
4
27
 
5
28
 
6
29
  ### Features
7
30
 
8
- * **api:** api update ([1682d74](https://github.com/orbcorp/orb-ruby/commit/1682d74396deb8eb97d937edf47b041df59e44ed))
31
+ * **api:** add `webhooks.standard.unwrap_standard`, which parses standard webhook payloads ([1682d74](https://github.com/orbcorp/orb-ruby/commit/1682d74396deb8eb97d937edf47b041df59e44ed))
9
32
 
10
33
 
11
34
  ### Chores
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", "~> 1.46.0"
18
+ gem "orb-billing", "~> 1.48.0"
19
19
  ```
20
20
 
21
21
  <!-- x-release-please-end -->
@@ -0,0 +1,34 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Orb
4
+ module Models
5
+ # @see Orb::Resources::CreditBlocks#update
6
+ class CreditBlockUpdateParams < Orb::Internal::Type::BaseModel
7
+ extend Orb::Internal::Type::RequestParameters::Converter
8
+ include Orb::Internal::Type::RequestParameters
9
+
10
+ # @!attribute block_id
11
+ #
12
+ # @return [String]
13
+ required :block_id, String
14
+
15
+ # @!attribute metadata
16
+ # User-specified key/value pairs for the resource. Individual keys can be removed
17
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
18
+ # by setting `metadata` to `null`.
19
+ #
20
+ # @return [Hash{Symbol=>String, nil}, nil]
21
+ optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
22
+
23
+ # @!method initialize(block_id:, metadata: nil, request_options: {})
24
+ # Some parameter documentations has been truncated, see
25
+ # {Orb::Models::CreditBlockUpdateParams} for more details.
26
+ #
27
+ # @param block_id [String]
28
+ #
29
+ # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
30
+ #
31
+ # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
32
+ end
33
+ end
34
+ end
@@ -0,0 +1,332 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Orb
4
+ module Models
5
+ # @see Orb::Resources::CreditBlocks#update
6
+ class CreditBlockUpdateResponse < Orb::Internal::Type::BaseModel
7
+ # @!attribute id
8
+ #
9
+ # @return [String]
10
+ required :id, String
11
+
12
+ # @!attribute balance
13
+ #
14
+ # @return [Float]
15
+ required :balance, Float
16
+
17
+ # @!attribute credit_block_source
18
+ # How this credit block was created: `allocation` (a subscription's recurring
19
+ # credit allocation), `top_up` (an automatic balance-threshold top-up),
20
+ # `commitment` (a subscription commitment true-up rolled forward as credit), or
21
+ # `manual` (a manual credit ledger increment, including credits voided or expired
22
+ # off another block).
23
+ #
24
+ # @return [Symbol, Orb::Models::CreditBlockUpdateResponse::CreditBlockSource]
25
+ required :credit_block_source, enum: -> { Orb::Models::CreditBlockUpdateResponse::CreditBlockSource }
26
+
27
+ # @!attribute effective_date
28
+ #
29
+ # @return [Time, nil]
30
+ required :effective_date, Time, nil?: true
31
+
32
+ # @!attribute expiry_date
33
+ #
34
+ # @return [Time, nil]
35
+ required :expiry_date, Time, nil?: true
36
+
37
+ # @!attribute filters
38
+ #
39
+ # @return [Array<Orb::Models::CreditBlockUpdateResponse::Filter>]
40
+ required :filters, -> { Orb::Internal::Type::ArrayOf[Orb::Models::CreditBlockUpdateResponse::Filter] }
41
+
42
+ # @!attribute maximum_initial_balance
43
+ #
44
+ # @return [Float, nil]
45
+ required :maximum_initial_balance, Float, nil?: true
46
+
47
+ # @!attribute metadata
48
+ # User specified key-value pairs for the resource. If not present, this defaults
49
+ # to an empty dictionary. Individual keys can be removed by setting the value to
50
+ # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
51
+ # `null`.
52
+ #
53
+ # @return [Hash{Symbol=>String}]
54
+ required :metadata, Orb::Internal::Type::HashOf[String]
55
+
56
+ # @!attribute per_unit_cost_basis
57
+ #
58
+ # @return [String, nil]
59
+ required :per_unit_cost_basis, String, nil?: true
60
+
61
+ # @!attribute status
62
+ #
63
+ # @return [Symbol, Orb::Models::CreditBlockUpdateResponse::Status]
64
+ required :status, enum: -> { Orb::Models::CreditBlockUpdateResponse::Status }
65
+
66
+ # @!attribute credit_allocation
67
+ # The credit allocation that funded a block. Extends the allocation resource
68
+ # serialized on prices with the catalog-item attribution of the funding price.
69
+ #
70
+ # @return [Orb::Models::CreditBlockUpdateResponse::CreditAllocation, nil]
71
+ optional :credit_allocation, -> { Orb::Models::CreditBlockUpdateResponse::CreditAllocation }, nil?: true
72
+
73
+ # @!attribute credit_commitment
74
+ # The subscription commitment whose true-up rolled forward into this credit block.
75
+ # Present only when `credit_block_source` is `commitment`.
76
+ #
77
+ # @return [Orb::Models::CreditBlockUpdateResponse::CreditCommitment, nil]
78
+ optional :credit_commitment, -> { Orb::Models::CreditBlockUpdateResponse::CreditCommitment }, nil?: true
79
+
80
+ # @!method initialize(id:, balance:, credit_block_source:, effective_date:, expiry_date:, filters:, maximum_initial_balance:, metadata:, per_unit_cost_basis:, status:, credit_allocation: nil, credit_commitment: nil)
81
+ # Some parameter documentations has been truncated, see
82
+ # {Orb::Models::CreditBlockUpdateResponse} for more details.
83
+ #
84
+ # The Credit Block resource models prepaid credits within Orb.
85
+ #
86
+ # @param id [String]
87
+ #
88
+ # @param balance [Float]
89
+ #
90
+ # @param credit_block_source [Symbol, Orb::Models::CreditBlockUpdateResponse::CreditBlockSource] How this credit block was created: `allocation` (a subscription's recurring cred
91
+ #
92
+ # @param effective_date [Time, nil]
93
+ #
94
+ # @param expiry_date [Time, nil]
95
+ #
96
+ # @param filters [Array<Orb::Models::CreditBlockUpdateResponse::Filter>]
97
+ #
98
+ # @param maximum_initial_balance [Float, nil]
99
+ #
100
+ # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
101
+ #
102
+ # @param per_unit_cost_basis [String, nil]
103
+ #
104
+ # @param status [Symbol, Orb::Models::CreditBlockUpdateResponse::Status]
105
+ #
106
+ # @param credit_allocation [Orb::Models::CreditBlockUpdateResponse::CreditAllocation, nil] The credit allocation that funded a block. Extends the allocation resource
107
+ #
108
+ # @param credit_commitment [Orb::Models::CreditBlockUpdateResponse::CreditCommitment, nil] The subscription commitment whose true-up rolled forward into this credit block.
109
+
110
+ # How this credit block was created: `allocation` (a subscription's recurring
111
+ # credit allocation), `top_up` (an automatic balance-threshold top-up),
112
+ # `commitment` (a subscription commitment true-up rolled forward as credit), or
113
+ # `manual` (a manual credit ledger increment, including credits voided or expired
114
+ # off another block).
115
+ #
116
+ # @see Orb::Models::CreditBlockUpdateResponse#credit_block_source
117
+ module CreditBlockSource
118
+ extend Orb::Internal::Type::Enum
119
+
120
+ ALLOCATION = :allocation
121
+ TOP_UP = :top_up
122
+ COMMITMENT = :commitment
123
+ MANUAL = :manual
124
+
125
+ # @!method self.values
126
+ # @return [Array<Symbol>]
127
+ end
128
+
129
+ class Filter < Orb::Internal::Type::BaseModel
130
+ # @!attribute field
131
+ # The property of the price to filter on.
132
+ #
133
+ # @return [Symbol, Orb::Models::CreditBlockUpdateResponse::Filter::Field]
134
+ required :field, enum: -> { Orb::Models::CreditBlockUpdateResponse::Filter::Field }
135
+
136
+ # @!attribute operator
137
+ # Should prices that match the filter be included or excluded.
138
+ #
139
+ # @return [Symbol, Orb::Models::CreditBlockUpdateResponse::Filter::Operator]
140
+ required :operator, enum: -> { Orb::Models::CreditBlockUpdateResponse::Filter::Operator }
141
+
142
+ # @!attribute values
143
+ # The IDs or values that match this filter.
144
+ #
145
+ # @return [Array<String>]
146
+ required :values, Orb::Internal::Type::ArrayOf[String]
147
+
148
+ # @!method initialize(field:, operator:, values:)
149
+ # @param field [Symbol, Orb::Models::CreditBlockUpdateResponse::Filter::Field] The property of the price to filter on.
150
+ #
151
+ # @param operator [Symbol, Orb::Models::CreditBlockUpdateResponse::Filter::Operator] Should prices that match the filter be included or excluded.
152
+ #
153
+ # @param values [Array<String>] The IDs or values that match this filter.
154
+
155
+ # The property of the price to filter on.
156
+ #
157
+ # @see Orb::Models::CreditBlockUpdateResponse::Filter#field
158
+ module Field
159
+ extend Orb::Internal::Type::Enum
160
+
161
+ PRICE_ID = :price_id
162
+ ITEM_ID = :item_id
163
+ PRICE_TYPE = :price_type
164
+ CURRENCY = :currency
165
+ PRICING_UNIT_ID = :pricing_unit_id
166
+
167
+ # @!method self.values
168
+ # @return [Array<Symbol>]
169
+ end
170
+
171
+ # Should prices that match the filter be included or excluded.
172
+ #
173
+ # @see Orb::Models::CreditBlockUpdateResponse::Filter#operator
174
+ module Operator
175
+ extend Orb::Internal::Type::Enum
176
+
177
+ INCLUDES = :includes
178
+ EXCLUDES = :excludes
179
+
180
+ # @!method self.values
181
+ # @return [Array<Symbol>]
182
+ end
183
+ end
184
+
185
+ # @see Orb::Models::CreditBlockUpdateResponse#status
186
+ module Status
187
+ extend Orb::Internal::Type::Enum
188
+
189
+ ACTIVE = :active
190
+ PENDING_PAYMENT = :pending_payment
191
+
192
+ # @!method self.values
193
+ # @return [Array<Symbol>]
194
+ end
195
+
196
+ # @see Orb::Models::CreditBlockUpdateResponse#credit_allocation
197
+ class CreditAllocation < Orb::Internal::Type::BaseModel
198
+ # @!attribute allows_rollover
199
+ #
200
+ # @return [Boolean]
201
+ required :allows_rollover, Orb::Internal::Type::Boolean
202
+
203
+ # @!attribute currency
204
+ #
205
+ # @return [String]
206
+ required :currency, String
207
+
208
+ # @!attribute custom_expiration
209
+ #
210
+ # @return [Orb::Models::CustomExpiration, nil]
211
+ required :custom_expiration, -> { Orb::CustomExpiration }, nil?: true
212
+
213
+ # @!attribute item_id
214
+ # The ID of the catalog item this block was allocated from, derived from the
215
+ # allocation's price.
216
+ #
217
+ # @return [String]
218
+ required :item_id, String
219
+
220
+ # @!attribute filters
221
+ #
222
+ # @return [Array<Orb::Models::CreditBlockUpdateResponse::CreditAllocation::Filter>, nil]
223
+ optional :filters,
224
+ -> { Orb::Internal::Type::ArrayOf[Orb::Models::CreditBlockUpdateResponse::CreditAllocation::Filter] }
225
+
226
+ # @!attribute license_type_id
227
+ #
228
+ # @return [String, nil]
229
+ optional :license_type_id, String, nil?: true
230
+
231
+ # @!method initialize(allows_rollover:, currency:, custom_expiration:, item_id:, filters: nil, license_type_id: nil)
232
+ # Some parameter documentations has been truncated, see
233
+ # {Orb::Models::CreditBlockUpdateResponse::CreditAllocation} for more details.
234
+ #
235
+ # The credit allocation that funded a block. Extends the allocation resource
236
+ # serialized on prices with the catalog-item attribution of the funding price.
237
+ #
238
+ # @param allows_rollover [Boolean]
239
+ #
240
+ # @param currency [String]
241
+ #
242
+ # @param custom_expiration [Orb::Models::CustomExpiration, nil]
243
+ #
244
+ # @param item_id [String] The ID of the catalog item this block was allocated from, derived from the alloc
245
+ #
246
+ # @param filters [Array<Orb::Models::CreditBlockUpdateResponse::CreditAllocation::Filter>]
247
+ #
248
+ # @param license_type_id [String, nil]
249
+
250
+ class Filter < Orb::Internal::Type::BaseModel
251
+ # @!attribute field
252
+ # The property of the price to filter on.
253
+ #
254
+ # @return [Symbol, Orb::Models::CreditBlockUpdateResponse::CreditAllocation::Filter::Field]
255
+ required :field, enum: -> { Orb::Models::CreditBlockUpdateResponse::CreditAllocation::Filter::Field }
256
+
257
+ # @!attribute operator
258
+ # Should prices that match the filter be included or excluded.
259
+ #
260
+ # @return [Symbol, Orb::Models::CreditBlockUpdateResponse::CreditAllocation::Filter::Operator]
261
+ required :operator,
262
+ enum: -> { Orb::Models::CreditBlockUpdateResponse::CreditAllocation::Filter::Operator }
263
+
264
+ # @!attribute values
265
+ # The IDs or values that match this filter.
266
+ #
267
+ # @return [Array<String>]
268
+ required :values, Orb::Internal::Type::ArrayOf[String]
269
+
270
+ # @!method initialize(field:, operator:, values:)
271
+ # @param field [Symbol, Orb::Models::CreditBlockUpdateResponse::CreditAllocation::Filter::Field] The property of the price to filter on.
272
+ #
273
+ # @param operator [Symbol, Orb::Models::CreditBlockUpdateResponse::CreditAllocation::Filter::Operator] Should prices that match the filter be included or excluded.
274
+ #
275
+ # @param values [Array<String>] The IDs or values that match this filter.
276
+
277
+ # The property of the price to filter on.
278
+ #
279
+ # @see Orb::Models::CreditBlockUpdateResponse::CreditAllocation::Filter#field
280
+ module Field
281
+ extend Orb::Internal::Type::Enum
282
+
283
+ PRICE_ID = :price_id
284
+ ITEM_ID = :item_id
285
+ PRICE_TYPE = :price_type
286
+ CURRENCY = :currency
287
+ PRICING_UNIT_ID = :pricing_unit_id
288
+
289
+ # @!method self.values
290
+ # @return [Array<Symbol>]
291
+ end
292
+
293
+ # Should prices that match the filter be included or excluded.
294
+ #
295
+ # @see Orb::Models::CreditBlockUpdateResponse::CreditAllocation::Filter#operator
296
+ module Operator
297
+ extend Orb::Internal::Type::Enum
298
+
299
+ INCLUDES = :includes
300
+ EXCLUDES = :excludes
301
+
302
+ # @!method self.values
303
+ # @return [Array<Symbol>]
304
+ end
305
+ end
306
+ end
307
+
308
+ # @see Orb::Models::CreditBlockUpdateResponse#credit_commitment
309
+ class CreditCommitment < Orb::Internal::Type::BaseModel
310
+ # @!attribute id
311
+ # The ID of the subscription commitment this block was rolled forward from.
312
+ #
313
+ # @return [String]
314
+ required :id, String
315
+
316
+ # @!attribute subscription_id
317
+ # The subscription the commitment belongs to.
318
+ #
319
+ # @return [String, nil]
320
+ optional :subscription_id, String, nil?: true
321
+
322
+ # @!method initialize(id:, subscription_id: nil)
323
+ # The subscription commitment whose true-up rolled forward into this credit block.
324
+ # Present only when `credit_block_source` is `commitment`.
325
+ #
326
+ # @param id [String] The ID of the subscription commitment this block was rolled forward from.
327
+ #
328
+ # @param subscription_id [String, nil] The subscription the commitment belongs to.
329
+ end
330
+ end
331
+ end
332
+ end
@@ -381,7 +381,8 @@ module Orb
381
381
  # Some parameter documentations has been truncated, see
382
382
  # {Orb::Models::InvoiceIssueSummaryResponse} for more details.
383
383
  #
384
- # #InvoiceApiResourceWithoutLineItems
384
+ # An invoice without its line items, subtotal, discounts, minimums or maximums.
385
+ # Fetch the invoice for those.
385
386
  #
386
387
  # @param id [String]
387
388
  #
@@ -16,7 +16,8 @@ module Orb
16
16
  required :created_at, Time
17
17
 
18
18
  # @!attribute invoice
19
- # #InvoiceApiResourceWithoutLineItems
19
+ # An invoice without its line items, subtotal, discounts, minimums or maximums.
20
+ # Fetch the invoice for those.
20
21
  #
21
22
  # @return [Orb::Models::InvoiceIssuedSummaryWebhookEvent::Invoice]
22
23
  required :invoice, -> { Orb::InvoiceIssuedSummaryWebhookEvent::Invoice }
@@ -50,7 +51,7 @@ module Orb
50
51
  #
51
52
  # @param created_at [Time] The time at which this event was created, to the second.
52
53
  #
53
- # @param invoice [Orb::Models::InvoiceIssuedSummaryWebhookEvent::Invoice] #InvoiceApiResourceWithoutLineItems
54
+ # @param invoice [Orb::Models::InvoiceIssuedSummaryWebhookEvent::Invoice] An invoice without its line items, subtotal, discounts, minimums or maximums. Fe
54
55
  #
55
56
  # @param payload_style [Symbol, Orb::Models::InvoiceIssuedSummaryWebhookEvent::PayloadStyle] The serialization style this payload was rendered in, as configured on the endpo
56
57
  #
@@ -437,7 +438,8 @@ module Orb
437
438
  # Some parameter documentations has been truncated, see
438
439
  # {Orb::Models::InvoiceIssuedSummaryWebhookEvent::Invoice} for more details.
439
440
  #
440
- # #InvoiceApiResourceWithoutLineItems
441
+ # An invoice without its line items, subtotal, discounts, minimums or maximums.
442
+ # Fetch the invoice for those.
441
443
  #
442
444
  # @param id [String]
443
445
  #
@@ -381,7 +381,8 @@ module Orb
381
381
  # Some parameter documentations has been truncated, see
382
382
  # {Orb::Models::InvoiceListSummaryResponse} for more details.
383
383
  #
384
- # #InvoiceApiResourceWithoutLineItems
384
+ # An invoice without its line items, subtotal, discounts, minimums or maximums.
385
+ # Fetch the invoice for those.
385
386
  #
386
387
  # @param id [String]
387
388
  #
@@ -0,0 +1,20 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Orb
4
+ module Models
5
+ # @see Orb::Resources::Metrics#archive
6
+ class MetricArchiveParams < Orb::Internal::Type::BaseModel
7
+ extend Orb::Internal::Type::RequestParameters::Converter
8
+ include Orb::Internal::Type::RequestParameters
9
+
10
+ # @!attribute metric_id
11
+ #
12
+ # @return [String]
13
+ required :metric_id, String
14
+
15
+ # @!method initialize(metric_id:, request_options: {})
16
+ # @param metric_id [String]
17
+ # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
18
+ end
19
+ end
20
+ end
@@ -40,7 +40,13 @@ module Orb
40
40
  # @return [Integer, nil]
41
41
  optional :limit, Integer
42
42
 
43
- # @!method initialize(created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, cursor: nil, limit: nil, request_options: {})
43
+ # @!attribute status
44
+ # The metric status to filter to ('active', 'archived', or 'draft').
45
+ #
46
+ # @return [Symbol, Orb::Models::MetricListParams::Status, nil]
47
+ optional :status, enum: -> { Orb::MetricListParams::Status }, nil?: true
48
+
49
+ # @!method initialize(created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, cursor: nil, limit: nil, status: nil, request_options: {})
44
50
  # Some parameter documentations has been truncated, see
45
51
  # {Orb::Models::MetricListParams} for more details.
46
52
  #
@@ -56,7 +62,21 @@ module Orb
56
62
  #
57
63
  # @param limit [Integer] The number of items to fetch. Defaults to 20.
58
64
  #
65
+ # @param status [Symbol, Orb::Models::MetricListParams::Status, nil] The metric status to filter to ('active', 'archived', or 'draft').
66
+ #
59
67
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
68
+
69
+ # The metric status to filter to ('active', 'archived', or 'draft').
70
+ module Status
71
+ extend Orb::Internal::Type::Enum
72
+
73
+ ACTIVE = :active
74
+ ARCHIVED = :archived
75
+ DRAFT = :draft
76
+
77
+ # @!method self.values
78
+ # @return [Array<Symbol>]
79
+ end
60
80
  end
61
81
  end
62
82
  end
@@ -0,0 +1,20 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Orb
4
+ module Models
5
+ # @see Orb::Resources::Metrics#unarchive
6
+ class MetricUnarchiveParams < Orb::Internal::Type::BaseModel
7
+ extend Orb::Internal::Type::RequestParameters::Converter
8
+ include Orb::Internal::Type::RequestParameters
9
+
10
+ # @!attribute metric_id
11
+ #
12
+ # @return [String]
13
+ required :metric_id, String
14
+
15
+ # @!method initialize(metric_id:, request_options: {})
16
+ # @param metric_id [String]
17
+ # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
18
+ end
19
+ end
20
+ end
@@ -12,6 +12,12 @@ module Orb
12
12
  # @return [String]
13
13
  required :metric_id, String
14
14
 
15
+ # @!attribute description
16
+ # A description of the metric.
17
+ #
18
+ # @return [String, nil]
19
+ optional :description, String, nil?: true
20
+
15
21
  # @!attribute metadata
16
22
  # User-specified key/value pairs for the resource. Individual keys can be removed
17
23
  # by setting the value to `null`, and the entire metadata mapping can be cleared
@@ -20,14 +26,24 @@ module Orb
20
26
  # @return [Hash{Symbol=>String, nil}, nil]
21
27
  optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
22
28
 
23
- # @!method initialize(metric_id:, metadata: nil, request_options: {})
29
+ # @!attribute name
30
+ # The name of the metric.
31
+ #
32
+ # @return [String, nil]
33
+ optional :name, String, nil?: true
34
+
35
+ # @!method initialize(metric_id:, description: nil, metadata: nil, name: nil, request_options: {})
24
36
  # Some parameter documentations has been truncated, see
25
37
  # {Orb::Models::MetricUpdateParams} for more details.
26
38
  #
27
39
  # @param metric_id [String]
28
40
  #
41
+ # @param description [String, nil] A description of the metric.
42
+ #
29
43
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
30
44
  #
45
+ # @param name [String, nil] The name of the metric.
46
+ #
31
47
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
32
48
  end
33
49
  end
@@ -34,7 +34,13 @@ module Orb
34
34
  # @return [Hash{Symbol=>String, nil}, nil]
35
35
  optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
36
36
 
37
- # @!method initialize(plan_id:, description: nil, external_plan_id: nil, metadata: nil, request_options: {})
37
+ # @!attribute name
38
+ # The name of the plan.
39
+ #
40
+ # @return [String, nil]
41
+ optional :name, String, nil?: true
42
+
43
+ # @!method initialize(plan_id:, description: nil, external_plan_id: nil, metadata: nil, name: nil, request_options: {})
38
44
  # Some parameter documentations has been truncated, see
39
45
  # {Orb::Models::PlanUpdateParams} for more details.
40
46
  #
@@ -46,6 +52,8 @@ module Orb
46
52
  #
47
53
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
48
54
  #
55
+ # @param name [String, nil] The name of the plan.
56
+ #
49
57
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
50
58
  end
51
59
  end
@@ -35,7 +35,13 @@ module Orb
35
35
  # @return [Hash{Symbol=>String, nil}, nil]
36
36
  optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
37
37
 
38
- # @!method initialize(other_external_plan_id:, description: nil, external_plan_id: nil, metadata: nil, request_options: {})
38
+ # @!attribute name
39
+ # The name of the plan.
40
+ #
41
+ # @return [String, nil]
42
+ optional :name, String, nil?: true
43
+
44
+ # @!method initialize(other_external_plan_id:, description: nil, external_plan_id: nil, metadata: nil, name: nil, request_options: {})
39
45
  # Some parameter documentations has been truncated, see
40
46
  # {Orb::Models::Plans::ExternalPlanIDUpdateParams} for more details.
41
47
  #
@@ -47,6 +53,8 @@ module Orb
47
53
  #
48
54
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
49
55
  #
56
+ # @param name [String, nil] The name of the plan.
57
+ #
50
58
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
51
59
  end
52
60
  end