orb-billing 1.45.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 (316) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +29 -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/backfill_reflected_standard_webhook_event.rb +206 -0
  21. data/lib/orb/models/webhooks/backfill_reverted_standard_webhook_event.rb +206 -0
  22. data/lib/orb/models/webhooks/billable_metric_edited_standard_webhook_event.rb +131 -0
  23. data/lib/orb/models/webhooks/credit_block_accounting_sync_failed_standard_webhook_event.rb +537 -0
  24. data/lib/orb/models/webhooks/credit_block_accounting_sync_succeeded_standard_webhook_event.rb +531 -0
  25. data/lib/orb/models/webhooks/credit_note_accounting_sync_failed_standard_webhook_event.rb +188 -0
  26. data/lib/orb/models/webhooks/credit_note_accounting_sync_succeeded_standard_webhook_event.rb +183 -0
  27. data/lib/orb/models/webhooks/credit_note_issued_standard_webhook_event.rb +90 -0
  28. data/lib/orb/models/webhooks/credit_note_marked_as_void_standard_webhook_event.rb +92 -0
  29. data/lib/orb/models/webhooks/customer_accounting_sync_failed_standard_webhook_event.rb +198 -0
  30. data/lib/orb/models/webhooks/customer_accounting_sync_succeeded_standard_webhook_event.rb +193 -0
  31. data/lib/orb/models/webhooks/customer_balance_transaction_created_standard_webhook_event.rb +240 -0
  32. data/lib/orb/models/webhooks/customer_created_standard_webhook_event.rb +106 -0
  33. data/lib/orb/models/webhooks/customer_credit_balance_depleted_standard_webhook_event.rb +597 -0
  34. data/lib/orb/models/webhooks/customer_credit_balance_dropped_standard_webhook_event.rb +603 -0
  35. data/lib/orb/models/webhooks/customer_credit_balance_recovered_standard_webhook_event.rb +597 -0
  36. data/lib/orb/models/webhooks/customer_credit_ledger_incremented_standard_webhook_event.rb +509 -0
  37. data/lib/orb/models/webhooks/customer_edited_standard_webhook_event.rb +371 -0
  38. data/lib/orb/models/webhooks/data_exports_transfer_error_standard_webhook_event.rb +130 -0
  39. data/lib/orb/models/webhooks/data_exports_transfer_success_standard_webhook_event.rb +124 -0
  40. data/lib/orb/models/webhooks/event_unmatched_event_standard_webhook_event.rb +134 -0
  41. data/lib/orb/models/webhooks/ingestion_unmatched_customer_ids_standard_webhook_event.rb +94 -0
  42. data/lib/orb/models/webhooks/invoice_accounting_sync_failed_standard_webhook_event.rb +974 -0
  43. data/lib/orb/models/webhooks/invoice_accounting_sync_succeeded_standard_webhook_event.rb +968 -0
  44. data/lib/orb/models/webhooks/invoice_automation_schedule_step_executed_standard_webhook_event.rb +367 -0
  45. data/lib/orb/models/webhooks/invoice_cost_data_exported_standard_webhook_event.rb +113 -0
  46. data/lib/orb/models/webhooks/invoice_due_date_recalculation_canceled_standard_webhook_event.rb +101 -0
  47. data/lib/orb/models/webhooks/invoice_due_date_recalculation_completed_standard_webhook_event.rb +101 -0
  48. data/lib/orb/models/webhooks/invoice_due_date_recalculation_started_standard_webhook_event.rb +95 -0
  49. data/lib/orb/models/webhooks/invoice_dunning_schedule_created_standard_webhook_event.rb +996 -0
  50. data/lib/orb/models/webhooks/invoice_dunning_schedule_ended_standard_webhook_event.rb +990 -0
  51. data/lib/orb/models/webhooks/invoice_dunning_schedule_reset_standard_webhook_event.rb +994 -0
  52. data/lib/orb/models/webhooks/invoice_dunning_schedule_step_executed_standard_webhook_event.rb +944 -0
  53. data/lib/orb/models/webhooks/invoice_edited_standard_webhook_event.rb +1367 -0
  54. data/lib/orb/models/webhooks/invoice_invoice_date_elapsed_standard_webhook_event.rb +151 -0
  55. data/lib/orb/models/webhooks/invoice_issue_failed_standard_webhook_event.rb +887 -0
  56. data/lib/orb/models/webhooks/invoice_issued_standard_webhook_event.rb +886 -0
  57. data/lib/orb/models/webhooks/invoice_issued_summary_standard_webhook_event.rb +889 -0
  58. data/lib/orb/models/webhooks/invoice_manually_marked_as_paid_standard_webhook_event.rb +901 -0
  59. data/lib/orb/models/webhooks/invoice_manually_marked_as_void_standard_webhook_event.rb +878 -0
  60. data/lib/orb/models/webhooks/invoice_payment_failed_standard_webhook_event.rb +901 -0
  61. data/lib/orb/models/webhooks/invoice_payment_processing_standard_webhook_event.rb +895 -0
  62. data/lib/orb/models/webhooks/invoice_payment_succeeded_standard_webhook_event.rb +910 -0
  63. data/lib/orb/models/webhooks/invoice_sync_failed_standard_webhook_event.rb +892 -0
  64. data/lib/orb/models/webhooks/invoice_sync_succeeded_standard_webhook_event.rb +894 -0
  65. data/lib/orb/models/webhooks/invoice_undo_mark_as_paid_standard_webhook_event.rb +877 -0
  66. data/lib/orb/models/webhooks/metric_events_dropped_by_watermark_standard_webhook_event.rb +125 -0
  67. data/lib/orb/models/webhooks/payment_method_created_standard_webhook_event.rb +184 -0
  68. data/lib/orb/models/webhooks/payment_method_deleted_standard_webhook_event.rb +184 -0
  69. data/lib/orb/models/webhooks/plan_created_standard_webhook_event.rb +119 -0
  70. data/lib/orb/models/webhooks/plan_default_version_set_standard_webhook_event.rb +139 -0
  71. data/lib/orb/models/webhooks/plan_edited_standard_webhook_event.rb +159 -0
  72. data/lib/orb/models/webhooks/plan_version_created_standard_webhook_event.rb +138 -0
  73. data/lib/orb/models/webhooks/price_edited_standard_webhook_event.rb +132 -0
  74. data/lib/orb/models/webhooks/resource_event_test_standard_webhook_event.rb +92 -0
  75. data/lib/orb/models/webhooks/sales_order_accounting_sync_failed_standard_webhook_event.rb +974 -0
  76. data/lib/orb/models/webhooks/sales_order_accounting_sync_succeeded_standard_webhook_event.rb +969 -0
  77. data/lib/orb/models/webhooks/standard_unwrap_standard_params.rb +16 -0
  78. data/lib/orb/models/webhooks/subscription_accounting_sync_failed_standard_webhook_event.rb +322 -0
  79. data/lib/orb/models/webhooks/subscription_accounting_sync_succeeded_standard_webhook_event.rb +316 -0
  80. data/lib/orb/models/webhooks/subscription_alert_disabled_standard_webhook_event.rb +663 -0
  81. data/lib/orb/models/webhooks/subscription_cancellation_scheduled_standard_webhook_event.rb +237 -0
  82. data/lib/orb/models/webhooks/subscription_cancellation_unscheduled_standard_webhook_event.rb +237 -0
  83. data/lib/orb/models/webhooks/subscription_cost_exceeded_standard_webhook_event.rb +692 -0
  84. data/lib/orb/models/webhooks/subscription_created_standard_webhook_event.rb +221 -0
  85. data/lib/orb/models/webhooks/subscription_edited_standard_webhook_event.rb +273 -0
  86. data/lib/orb/models/webhooks/subscription_ended_standard_webhook_event.rb +219 -0
  87. data/lib/orb/models/webhooks/subscription_fixed_fee_quantity_updated_standard_webhook_event.rb +255 -0
  88. data/lib/orb/models/webhooks/subscription_grouped_cost_exceeded_standard_webhook_event.rb +689 -0
  89. data/lib/orb/models/webhooks/subscription_invoicing_threshold_exceeded_standard_webhook_event.rb +218 -0
  90. data/lib/orb/models/webhooks/subscription_license_allocation_reset_standard_webhook_event.rb +240 -0
  91. data/lib/orb/models/webhooks/subscription_license_balance_threshold_reached_standard_webhook_event.rb +683 -0
  92. data/lib/orb/models/webhooks/subscription_plan_change_scheduled_standard_webhook_event.rb +249 -0
  93. data/lib/orb/models/webhooks/subscription_plan_changed_standard_webhook_event.rb +233 -0
  94. data/lib/orb/models/webhooks/subscription_plan_version_change_scheduled_standard_webhook_event.rb +250 -0
  95. data/lib/orb/models/webhooks/subscription_plan_version_changed_standard_webhook_event.rb +248 -0
  96. data/lib/orb/models/webhooks/subscription_spend_exceeded_standard_webhook_event.rb +693 -0
  97. data/lib/orb/models/webhooks/subscription_started_standard_webhook_event.rb +221 -0
  98. data/lib/orb/models/webhooks/subscription_trial_ended_standard_webhook_event.rb +222 -0
  99. data/lib/orb/models/webhooks/subscription_usage_exceeded_standard_webhook_event.rb +700 -0
  100. data/lib/orb/models/webhooks/transaction_accounting_sync_failed_standard_webhook_event.rb +270 -0
  101. data/lib/orb/models/webhooks/transaction_accounting_sync_succeeded_standard_webhook_event.rb +264 -0
  102. data/lib/orb/models/webhooks/unwrap_standard_webhook_event.rb +258 -0
  103. data/lib/orb/models.rb +2 -0
  104. data/lib/orb/resources/metrics.rb +15 -5
  105. data/lib/orb/resources/plans/external_plan_id.rb +6 -3
  106. data/lib/orb/resources/plans.rb +6 -3
  107. data/lib/orb/resources/webhook_endpoints.rb +6 -2
  108. data/lib/orb/resources/webhooks/standard.rb +24 -0
  109. data/lib/orb/resources/webhooks.rb +4 -0
  110. data/lib/orb/version.rb +1 -1
  111. data/lib/orb.rb +84 -0
  112. data/rbi/orb/models/invoice_issue_summary_response.rbi +2 -1
  113. data/rbi/orb/models/invoice_issued_summary_webhook_event.rbi +6 -3
  114. data/rbi/orb/models/invoice_list_summary_response.rbi +2 -1
  115. data/rbi/orb/models/metric_list_params.rbi +29 -0
  116. data/rbi/orb/models/metric_update_params.rbi +16 -0
  117. data/rbi/orb/models/plan_update_params.rbi +8 -0
  118. data/rbi/orb/models/plans/external_plan_id_update_params.rbi +8 -0
  119. data/rbi/orb/models/subscription_alert_disabled_webhook_event.rbi +6 -12
  120. data/rbi/orb/models/subscription_grouped_cost_exceeded_webhook_event.rbi +6 -12
  121. data/rbi/orb/models/subscription_invoicing_threshold_exceeded_webhook_event.rbi +6 -12
  122. data/rbi/orb/models/subscription_license_allocation_reset_webhook_event.rbi +6 -12
  123. data/rbi/orb/models/subscription_license_balance_threshold_reached_webhook_event.rbi +6 -12
  124. data/rbi/orb/models/webhook_endpoint.rbi +39 -0
  125. data/rbi/orb/models/webhook_endpoint_create_params.rbi +51 -0
  126. data/rbi/orb/models/webhook_endpoint_update_params.rbi +51 -0
  127. data/rbi/orb/models/webhook_endpoint_with_secret.rbi +50 -0
  128. data/rbi/orb/models/webhooks/backfill_reflected_standard_webhook_event.rbi +349 -0
  129. data/rbi/orb/models/webhooks/backfill_reverted_standard_webhook_event.rbi +347 -0
  130. data/rbi/orb/models/webhooks/billable_metric_edited_standard_webhook_event.rbi +273 -0
  131. data/rbi/orb/models/webhooks/credit_block_accounting_sync_failed_standard_webhook_event.rbi +1106 -0
  132. data/rbi/orb/models/webhooks/credit_block_accounting_sync_succeeded_standard_webhook_event.rbi +1095 -0
  133. data/rbi/orb/models/webhooks/credit_note_accounting_sync_failed_standard_webhook_event.rbi +377 -0
  134. data/rbi/orb/models/webhooks/credit_note_accounting_sync_succeeded_standard_webhook_event.rbi +366 -0
  135. data/rbi/orb/models/webhooks/credit_note_issued_standard_webhook_event.rbi +166 -0
  136. data/rbi/orb/models/webhooks/credit_note_marked_as_void_standard_webhook_event.rbi +166 -0
  137. data/rbi/orb/models/webhooks/customer_accounting_sync_failed_standard_webhook_event.rbi +403 -0
  138. data/rbi/orb/models/webhooks/customer_accounting_sync_succeeded_standard_webhook_event.rbi +392 -0
  139. data/rbi/orb/models/webhooks/customer_balance_transaction_created_standard_webhook_event.rbi +493 -0
  140. data/rbi/orb/models/webhooks/customer_created_standard_webhook_event.rbi +198 -0
  141. data/rbi/orb/models/webhooks/customer_credit_balance_depleted_standard_webhook_event.rbi +1151 -0
  142. data/rbi/orb/models/webhooks/customer_credit_balance_dropped_standard_webhook_event.rbi +1158 -0
  143. data/rbi/orb/models/webhooks/customer_credit_balance_recovered_standard_webhook_event.rbi +1151 -0
  144. data/rbi/orb/models/webhooks/customer_credit_ledger_incremented_standard_webhook_event.rbi +1044 -0
  145. data/rbi/orb/models/webhooks/customer_edited_standard_webhook_event.rbi +678 -0
  146. data/rbi/orb/models/webhooks/data_exports_transfer_error_standard_webhook_event.rbi +236 -0
  147. data/rbi/orb/models/webhooks/data_exports_transfer_success_standard_webhook_event.rbi +230 -0
  148. data/rbi/orb/models/webhooks/event_unmatched_event_standard_webhook_event.rbi +275 -0
  149. data/rbi/orb/models/webhooks/ingestion_unmatched_customer_ids_standard_webhook_event.rbi +192 -0
  150. data/rbi/orb/models/webhooks/invoice_accounting_sync_failed_standard_webhook_event.rbi +1708 -0
  151. data/rbi/orb/models/webhooks/invoice_accounting_sync_succeeded_standard_webhook_event.rbi +1697 -0
  152. data/rbi/orb/models/webhooks/invoice_automation_schedule_step_executed_standard_webhook_event.rbi +670 -0
  153. data/rbi/orb/models/webhooks/invoice_cost_data_exported_standard_webhook_event.rbi +210 -0
  154. data/rbi/orb/models/webhooks/invoice_due_date_recalculation_canceled_standard_webhook_event.rbi +195 -0
  155. data/rbi/orb/models/webhooks/invoice_due_date_recalculation_completed_standard_webhook_event.rbi +195 -0
  156. data/rbi/orb/models/webhooks/invoice_due_date_recalculation_started_standard_webhook_event.rbi +188 -0
  157. data/rbi/orb/models/webhooks/invoice_dunning_schedule_created_standard_webhook_event.rbi +1716 -0
  158. data/rbi/orb/models/webhooks/invoice_dunning_schedule_ended_standard_webhook_event.rbi +1711 -0
  159. data/rbi/orb/models/webhooks/invoice_dunning_schedule_reset_standard_webhook_event.rbi +1716 -0
  160. data/rbi/orb/models/webhooks/invoice_dunning_schedule_step_executed_standard_webhook_event.rbi +1631 -0
  161. data/rbi/orb/models/webhooks/invoice_edited_standard_webhook_event.rbi +2340 -0
  162. data/rbi/orb/models/webhooks/invoice_invoice_date_elapsed_standard_webhook_event.rbi +324 -0
  163. data/rbi/orb/models/webhooks/invoice_issue_failed_standard_webhook_event.rbi +1532 -0
  164. data/rbi/orb/models/webhooks/invoice_issued_standard_webhook_event.rbi +1532 -0
  165. data/rbi/orb/models/webhooks/invoice_issued_summary_standard_webhook_event.rbi +1537 -0
  166. data/rbi/orb/models/webhooks/invoice_manually_marked_as_paid_standard_webhook_event.rbi +1552 -0
  167. data/rbi/orb/models/webhooks/invoice_manually_marked_as_void_standard_webhook_event.rbi +1497 -0
  168. data/rbi/orb/models/webhooks/invoice_payment_failed_standard_webhook_event.rbi +1557 -0
  169. data/rbi/orb/models/webhooks/invoice_payment_processing_standard_webhook_event.rbi +1550 -0
  170. data/rbi/orb/models/webhooks/invoice_payment_succeeded_standard_webhook_event.rbi +1566 -0
  171. data/rbi/orb/models/webhooks/invoice_sync_failed_standard_webhook_event.rbi +1545 -0
  172. data/rbi/orb/models/webhooks/invoice_sync_succeeded_standard_webhook_event.rbi +1547 -0
  173. data/rbi/orb/models/webhooks/invoice_undo_mark_as_paid_standard_webhook_event.rbi +1497 -0
  174. data/rbi/orb/models/webhooks/metric_events_dropped_by_watermark_standard_webhook_event.rbi +233 -0
  175. data/rbi/orb/models/webhooks/payment_method_created_standard_webhook_event.rbi +331 -0
  176. data/rbi/orb/models/webhooks/payment_method_deleted_standard_webhook_event.rbi +331 -0
  177. data/rbi/orb/models/webhooks/plan_created_standard_webhook_event.rbi +216 -0
  178. data/rbi/orb/models/webhooks/plan_default_version_set_standard_webhook_event.rbi +277 -0
  179. data/rbi/orb/models/webhooks/plan_edited_standard_webhook_event.rbi +337 -0
  180. data/rbi/orb/models/webhooks/plan_version_created_standard_webhook_event.rbi +271 -0
  181. data/rbi/orb/models/webhooks/price_edited_standard_webhook_event.rbi +311 -0
  182. data/rbi/orb/models/webhooks/resource_event_test_standard_webhook_event.rbi +191 -0
  183. data/rbi/orb/models/webhooks/sales_order_accounting_sync_failed_standard_webhook_event.rbi +1708 -0
  184. data/rbi/orb/models/webhooks/sales_order_accounting_sync_succeeded_standard_webhook_event.rbi +1697 -0
  185. data/rbi/orb/models/webhooks/standard_unwrap_standard_params.rbi +32 -0
  186. data/rbi/orb/models/webhooks/subscription_accounting_sync_failed_standard_webhook_event.rbi +609 -0
  187. data/rbi/orb/models/webhooks/subscription_accounting_sync_succeeded_standard_webhook_event.rbi +598 -0
  188. data/rbi/orb/models/webhooks/subscription_alert_disabled_standard_webhook_event.rbi +1296 -0
  189. data/rbi/orb/models/webhooks/subscription_cancellation_scheduled_standard_webhook_event.rbi +433 -0
  190. data/rbi/orb/models/webhooks/subscription_cancellation_unscheduled_standard_webhook_event.rbi +435 -0
  191. data/rbi/orb/models/webhooks/subscription_cost_exceeded_standard_webhook_event.rbi +1298 -0
  192. data/rbi/orb/models/webhooks/subscription_created_standard_webhook_event.rbi +398 -0
  193. data/rbi/orb/models/webhooks/subscription_edited_standard_webhook_event.rbi +520 -0
  194. data/rbi/orb/models/webhooks/subscription_ended_standard_webhook_event.rbi +398 -0
  195. data/rbi/orb/models/webhooks/subscription_fixed_fee_quantity_updated_standard_webhook_event.rbi +458 -0
  196. data/rbi/orb/models/webhooks/subscription_grouped_cost_exceeded_standard_webhook_event.rbi +1315 -0
  197. data/rbi/orb/models/webhooks/subscription_invoicing_threshold_exceeded_standard_webhook_event.rbi +422 -0
  198. data/rbi/orb/models/webhooks/subscription_license_allocation_reset_standard_webhook_event.rbi +471 -0
  199. data/rbi/orb/models/webhooks/subscription_license_balance_threshold_reached_standard_webhook_event.rbi +1313 -0
  200. data/rbi/orb/models/webhooks/subscription_plan_change_scheduled_standard_webhook_event.rbi +453 -0
  201. data/rbi/orb/models/webhooks/subscription_plan_changed_standard_webhook_event.rbi +433 -0
  202. data/rbi/orb/models/webhooks/subscription_plan_version_change_scheduled_standard_webhook_event.rbi +457 -0
  203. data/rbi/orb/models/webhooks/subscription_plan_version_changed_standard_webhook_event.rbi +457 -0
  204. data/rbi/orb/models/webhooks/subscription_spend_exceeded_standard_webhook_event.rbi +1299 -0
  205. data/rbi/orb/models/webhooks/subscription_started_standard_webhook_event.rbi +398 -0
  206. data/rbi/orb/models/webhooks/subscription_trial_ended_standard_webhook_event.rbi +398 -0
  207. data/rbi/orb/models/webhooks/subscription_usage_exceeded_standard_webhook_event.rbi +1305 -0
  208. data/rbi/orb/models/webhooks/transaction_accounting_sync_failed_standard_webhook_event.rbi +516 -0
  209. data/rbi/orb/models/webhooks/transaction_accounting_sync_succeeded_standard_webhook_event.rbi +505 -0
  210. data/rbi/orb/models/webhooks/unwrap_standard_webhook_event.rbi +107 -0
  211. data/rbi/orb/models.rbi +2 -0
  212. data/rbi/orb/resources/metrics.rbi +16 -3
  213. data/rbi/orb/resources/plans/external_plan_id.rbi +6 -2
  214. data/rbi/orb/resources/plans.rbi +6 -2
  215. data/rbi/orb/resources/webhook_endpoints.rbi +10 -0
  216. data/rbi/orb/resources/webhooks/standard.rbi +107 -0
  217. data/rbi/orb/resources/webhooks.rbi +3 -0
  218. data/sig/orb/models/metric_list_params.rbs +18 -1
  219. data/sig/orb/models/metric_update_params.rbs +14 -1
  220. data/sig/orb/models/plan_update_params.rbs +6 -1
  221. data/sig/orb/models/plans/external_plan_id_update_params.rbs +6 -1
  222. data/sig/orb/models/webhook_endpoint.rbs +16 -0
  223. data/sig/orb/models/webhook_endpoint_create_params.rbs +20 -1
  224. data/sig/orb/models/webhook_endpoint_update_params.rbs +16 -0
  225. data/sig/orb/models/webhook_endpoint_with_secret.rbs +16 -0
  226. data/sig/orb/models/webhooks/backfill_reflected_standard_webhook_event.rbs +148 -0
  227. data/sig/orb/models/webhooks/backfill_reverted_standard_webhook_event.rbs +148 -0
  228. data/sig/orb/models/webhooks/billable_metric_edited_standard_webhook_event.rbs +112 -0
  229. data/sig/orb/models/webhooks/credit_block_accounting_sync_failed_standard_webhook_event.rbs +435 -0
  230. data/sig/orb/models/webhooks/credit_block_accounting_sync_succeeded_standard_webhook_event.rbs +430 -0
  231. data/sig/orb/models/webhooks/credit_note_accounting_sync_failed_standard_webhook_event.rbs +165 -0
  232. data/sig/orb/models/webhooks/credit_note_accounting_sync_succeeded_standard_webhook_event.rbs +160 -0
  233. data/sig/orb/models/webhooks/credit_note_issued_standard_webhook_event.rbs +68 -0
  234. data/sig/orb/models/webhooks/credit_note_marked_as_void_standard_webhook_event.rbs +68 -0
  235. data/sig/orb/models/webhooks/customer_accounting_sync_failed_standard_webhook_event.rbs +160 -0
  236. data/sig/orb/models/webhooks/customer_accounting_sync_succeeded_standard_webhook_event.rbs +155 -0
  237. data/sig/orb/models/webhooks/customer_balance_transaction_created_standard_webhook_event.rbs +189 -0
  238. data/sig/orb/models/webhooks/customer_created_standard_webhook_event.rbs +68 -0
  239. data/sig/orb/models/webhooks/customer_credit_balance_depleted_standard_webhook_event.rbs +396 -0
  240. data/sig/orb/models/webhooks/customer_credit_balance_dropped_standard_webhook_event.rbs +401 -0
  241. data/sig/orb/models/webhooks/customer_credit_balance_recovered_standard_webhook_event.rbs +396 -0
  242. data/sig/orb/models/webhooks/customer_credit_ledger_incremented_standard_webhook_event.rbs +386 -0
  243. data/sig/orb/models/webhooks/customer_edited_standard_webhook_event.rbs +157 -0
  244. data/sig/orb/models/webhooks/data_exports_transfer_error_standard_webhook_event.rbs +110 -0
  245. data/sig/orb/models/webhooks/data_exports_transfer_success_standard_webhook_event.rbs +105 -0
  246. data/sig/orb/models/webhooks/event_unmatched_event_standard_webhook_event.rbs +122 -0
  247. data/sig/orb/models/webhooks/ingestion_unmatched_customer_ids_standard_webhook_event.rbs +73 -0
  248. data/sig/orb/models/webhooks/invoice_accounting_sync_failed_standard_webhook_event.rbs +614 -0
  249. data/sig/orb/models/webhooks/invoice_accounting_sync_succeeded_standard_webhook_event.rbs +609 -0
  250. data/sig/orb/models/webhooks/invoice_automation_schedule_step_executed_standard_webhook_event.rbs +331 -0
  251. data/sig/orb/models/webhooks/invoice_cost_data_exported_standard_webhook_event.rbs +91 -0
  252. data/sig/orb/models/webhooks/invoice_due_date_recalculation_canceled_standard_webhook_event.rbs +75 -0
  253. data/sig/orb/models/webhooks/invoice_due_date_recalculation_completed_standard_webhook_event.rbs +75 -0
  254. data/sig/orb/models/webhooks/invoice_due_date_recalculation_started_standard_webhook_event.rbs +73 -0
  255. data/sig/orb/models/webhooks/invoice_dunning_schedule_created_standard_webhook_event.rbs +638 -0
  256. data/sig/orb/models/webhooks/invoice_dunning_schedule_ended_standard_webhook_event.rbs +633 -0
  257. data/sig/orb/models/webhooks/invoice_dunning_schedule_reset_standard_webhook_event.rbs +623 -0
  258. data/sig/orb/models/webhooks/invoice_dunning_schedule_step_executed_standard_webhook_event.rbs +586 -0
  259. data/sig/orb/models/webhooks/invoice_edited_standard_webhook_event.rbs +859 -0
  260. data/sig/orb/models/webhooks/invoice_invoice_date_elapsed_standard_webhook_event.rbs +129 -0
  261. data/sig/orb/models/webhooks/invoice_issue_failed_standard_webhook_event.rbs +527 -0
  262. data/sig/orb/models/webhooks/invoice_issued_standard_webhook_event.rbs +527 -0
  263. data/sig/orb/models/webhooks/invoice_issued_summary_standard_webhook_event.rbs +527 -0
  264. data/sig/orb/models/webhooks/invoice_manually_marked_as_paid_standard_webhook_event.rbs +540 -0
  265. data/sig/orb/models/webhooks/invoice_manually_marked_as_void_standard_webhook_event.rbs +517 -0
  266. data/sig/orb/models/webhooks/invoice_payment_failed_standard_webhook_event.rbs +544 -0
  267. data/sig/orb/models/webhooks/invoice_payment_processing_standard_webhook_event.rbs +538 -0
  268. data/sig/orb/models/webhooks/invoice_payment_succeeded_standard_webhook_event.rbs +549 -0
  269. data/sig/orb/models/webhooks/invoice_sync_failed_standard_webhook_event.rbs +536 -0
  270. data/sig/orb/models/webhooks/invoice_sync_succeeded_standard_webhook_event.rbs +536 -0
  271. data/sig/orb/models/webhooks/invoice_undo_mark_as_paid_standard_webhook_event.rbs +517 -0
  272. data/sig/orb/models/webhooks/metric_events_dropped_by_watermark_standard_webhook_event.rbs +100 -0
  273. data/sig/orb/models/webhooks/payment_method_created_standard_webhook_event.rbs +130 -0
  274. data/sig/orb/models/webhooks/payment_method_deleted_standard_webhook_event.rbs +130 -0
  275. data/sig/orb/models/webhooks/plan_created_standard_webhook_event.rbs +90 -0
  276. data/sig/orb/models/webhooks/plan_default_version_set_standard_webhook_event.rbs +112 -0
  277. data/sig/orb/models/webhooks/plan_edited_standard_webhook_event.rbs +134 -0
  278. data/sig/orb/models/webhooks/plan_version_created_standard_webhook_event.rbs +109 -0
  279. data/sig/orb/models/webhooks/price_edited_standard_webhook_event.rbs +95 -0
  280. data/sig/orb/models/webhooks/resource_event_test_standard_webhook_event.rbs +75 -0
  281. data/sig/orb/models/webhooks/sales_order_accounting_sync_failed_standard_webhook_event.rbs +614 -0
  282. data/sig/orb/models/webhooks/sales_order_accounting_sync_succeeded_standard_webhook_event.rbs +609 -0
  283. data/sig/orb/models/webhooks/standard_unwrap_standard_params.rbs +17 -0
  284. data/sig/orb/models/webhooks/subscription_accounting_sync_failed_standard_webhook_event.rbs +256 -0
  285. data/sig/orb/models/webhooks/subscription_accounting_sync_succeeded_standard_webhook_event.rbs +251 -0
  286. data/sig/orb/models/webhooks/subscription_alert_disabled_standard_webhook_event.rbs +466 -0
  287. data/sig/orb/models/webhooks/subscription_cancellation_scheduled_standard_webhook_event.rbs +169 -0
  288. data/sig/orb/models/webhooks/subscription_cancellation_unscheduled_standard_webhook_event.rbs +169 -0
  289. data/sig/orb/models/webhooks/subscription_cost_exceeded_standard_webhook_event.rbs +475 -0
  290. data/sig/orb/models/webhooks/subscription_created_standard_webhook_event.rbs +159 -0
  291. data/sig/orb/models/webhooks/subscription_edited_standard_webhook_event.rbs +218 -0
  292. data/sig/orb/models/webhooks/subscription_ended_standard_webhook_event.rbs +159 -0
  293. data/sig/orb/models/webhooks/subscription_fixed_fee_quantity_updated_standard_webhook_event.rbs +191 -0
  294. data/sig/orb/models/webhooks/subscription_grouped_cost_exceeded_standard_webhook_event.rbs +487 -0
  295. data/sig/orb/models/webhooks/subscription_invoicing_threshold_exceeded_standard_webhook_event.rbs +176 -0
  296. data/sig/orb/models/webhooks/subscription_license_allocation_reset_standard_webhook_event.rbs +198 -0
  297. data/sig/orb/models/webhooks/subscription_license_balance_threshold_reached_standard_webhook_event.rbs +482 -0
  298. data/sig/orb/models/webhooks/subscription_plan_change_scheduled_standard_webhook_event.rbs +182 -0
  299. data/sig/orb/models/webhooks/subscription_plan_changed_standard_webhook_event.rbs +169 -0
  300. data/sig/orb/models/webhooks/subscription_plan_version_change_scheduled_standard_webhook_event.rbs +186 -0
  301. data/sig/orb/models/webhooks/subscription_plan_version_changed_standard_webhook_event.rbs +186 -0
  302. data/sig/orb/models/webhooks/subscription_spend_exceeded_standard_webhook_event.rbs +475 -0
  303. data/sig/orb/models/webhooks/subscription_started_standard_webhook_event.rbs +159 -0
  304. data/sig/orb/models/webhooks/subscription_trial_ended_standard_webhook_event.rbs +159 -0
  305. data/sig/orb/models/webhooks/subscription_usage_exceeded_standard_webhook_event.rbs +480 -0
  306. data/sig/orb/models/webhooks/transaction_accounting_sync_failed_standard_webhook_event.rbs +223 -0
  307. data/sig/orb/models/webhooks/transaction_accounting_sync_succeeded_standard_webhook_event.rbs +218 -0
  308. data/sig/orb/models/webhooks/unwrap_standard_webhook_event.rbs +94 -0
  309. data/sig/orb/models.rbs +2 -0
  310. data/sig/orb/resources/metrics.rbs +3 -0
  311. data/sig/orb/resources/plans/external_plan_id.rbs +1 -0
  312. data/sig/orb/resources/plans.rbs +1 -0
  313. data/sig/orb/resources/webhook_endpoints.rbs +2 -0
  314. data/sig/orb/resources/webhooks/standard.rbs +93 -0
  315. data/sig/orb/resources/webhooks.rbs +2 -0
  316. metadata +253 -1
@@ -0,0 +1,505 @@
1
+ # typed: strong
2
+
3
+ module Orb
4
+ module Models
5
+ module Webhooks
6
+ class TransactionAccountingSyncSucceededStandardWebhookEvent < Orb::Internal::Type::BaseModel
7
+ OrHash =
8
+ T.type_alias do
9
+ T.any(
10
+ Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent,
11
+ Orb::Internal::AnyHash
12
+ )
13
+ end
14
+
15
+ # The ID of this webhook event.
16
+ sig { returns(String) }
17
+ attr_accessor :id
18
+
19
+ sig do
20
+ returns(
21
+ Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::AccountingSyncRecord
22
+ )
23
+ end
24
+ attr_reader :accounting_sync_record
25
+
26
+ sig do
27
+ params(
28
+ accounting_sync_record:
29
+ Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::AccountingSyncRecord::OrHash
30
+ ).void
31
+ end
32
+ attr_writer :accounting_sync_record
33
+
34
+ # The time at which this event was created, to the second.
35
+ sig { returns(Time) }
36
+ attr_accessor :created_at
37
+
38
+ # The serialization style this payload was rendered in, as configured on the
39
+ # endpoint.
40
+ sig do
41
+ returns(
42
+ Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::PayloadStyle::TaggedSymbol
43
+ )
44
+ end
45
+ attr_accessor :payload_style
46
+
47
+ sig do
48
+ returns(
49
+ Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::Properties
50
+ )
51
+ end
52
+ attr_reader :properties
53
+
54
+ sig do
55
+ params(
56
+ properties:
57
+ Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::Properties::OrHash
58
+ ).void
59
+ end
60
+ attr_writer :properties
61
+
62
+ sig do
63
+ returns(
64
+ Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::Transaction
65
+ )
66
+ end
67
+ attr_reader :transaction
68
+
69
+ sig do
70
+ params(
71
+ transaction:
72
+ Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::Transaction::OrHash
73
+ ).void
74
+ end
75
+ attr_writer :transaction
76
+
77
+ # The event this payload describes.
78
+ sig do
79
+ returns(
80
+ Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::Type::TaggedSymbol
81
+ )
82
+ end
83
+ attr_accessor :type
84
+
85
+ # Issued when a transaction accounting sync succeeds.
86
+ sig do
87
+ params(
88
+ id: String,
89
+ accounting_sync_record:
90
+ Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::AccountingSyncRecord::OrHash,
91
+ created_at: Time,
92
+ payload_style:
93
+ Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::PayloadStyle::OrSymbol,
94
+ properties:
95
+ Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::Properties::OrHash,
96
+ transaction:
97
+ Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::Transaction::OrHash,
98
+ type:
99
+ Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::Type::OrSymbol
100
+ ).returns(T.attached_class)
101
+ end
102
+ def self.new(
103
+ # The ID of this webhook event.
104
+ id:,
105
+ accounting_sync_record:,
106
+ # The time at which this event was created, to the second.
107
+ created_at:,
108
+ # The serialization style this payload was rendered in, as configured on the
109
+ # endpoint.
110
+ payload_style:,
111
+ properties:,
112
+ transaction:,
113
+ # The event this payload describes.
114
+ type:
115
+ )
116
+ end
117
+
118
+ sig do
119
+ override.returns(
120
+ {
121
+ id: String,
122
+ accounting_sync_record:
123
+ Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::AccountingSyncRecord,
124
+ created_at: Time,
125
+ payload_style:
126
+ Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::PayloadStyle::TaggedSymbol,
127
+ properties:
128
+ Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::Properties,
129
+ transaction:
130
+ Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::Transaction,
131
+ type:
132
+ Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::Type::TaggedSymbol
133
+ }
134
+ )
135
+ end
136
+ def to_hash
137
+ end
138
+
139
+ class AccountingSyncRecord < Orb::Internal::Type::BaseModel
140
+ OrHash =
141
+ T.type_alias do
142
+ T.any(
143
+ Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::AccountingSyncRecord,
144
+ Orb::Internal::AnyHash
145
+ )
146
+ end
147
+
148
+ sig { returns(String) }
149
+ attr_accessor :id
150
+
151
+ sig { returns(String) }
152
+ attr_accessor :customer_id
153
+
154
+ sig do
155
+ returns(
156
+ Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::AccountingSyncRecord::RecordType::TaggedSymbol
157
+ )
158
+ end
159
+ attr_accessor :record_type
160
+
161
+ sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
162
+ attr_accessor :error_details
163
+
164
+ sig { returns(T.nilable(String)) }
165
+ attr_accessor :provider_customer_id
166
+
167
+ sig { returns(T.nilable(String)) }
168
+ attr_accessor :status
169
+
170
+ sig { returns(T.nilable(String)) }
171
+ attr_accessor :sync_action
172
+
173
+ sig { returns(T.nilable(String)) }
174
+ attr_accessor :transaction_record_id
175
+
176
+ sig do
177
+ params(
178
+ id: String,
179
+ customer_id: String,
180
+ record_type:
181
+ Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::AccountingSyncRecord::RecordType::OrSymbol,
182
+ error_details: T.nilable(T::Hash[Symbol, T.anything]),
183
+ provider_customer_id: T.nilable(String),
184
+ status: T.nilable(String),
185
+ sync_action: T.nilable(String),
186
+ transaction_record_id: T.nilable(String)
187
+ ).returns(T.attached_class)
188
+ end
189
+ def self.new(
190
+ id:,
191
+ customer_id:,
192
+ record_type:,
193
+ error_details: nil,
194
+ provider_customer_id: nil,
195
+ status: nil,
196
+ sync_action: nil,
197
+ transaction_record_id: nil
198
+ )
199
+ end
200
+
201
+ sig do
202
+ override.returns(
203
+ {
204
+ id: String,
205
+ customer_id: String,
206
+ record_type:
207
+ Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::AccountingSyncRecord::RecordType::TaggedSymbol,
208
+ error_details: T.nilable(T::Hash[Symbol, T.anything]),
209
+ provider_customer_id: T.nilable(String),
210
+ status: T.nilable(String),
211
+ sync_action: T.nilable(String),
212
+ transaction_record_id: T.nilable(String)
213
+ }
214
+ )
215
+ end
216
+ def to_hash
217
+ end
218
+
219
+ module RecordType
220
+ extend Orb::Internal::Type::Enum
221
+
222
+ TaggedSymbol =
223
+ T.type_alias do
224
+ T.all(
225
+ Symbol,
226
+ Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::AccountingSyncRecord::RecordType
227
+ )
228
+ end
229
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
230
+
231
+ CUSTOMER =
232
+ T.let(
233
+ :customer,
234
+ Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::AccountingSyncRecord::RecordType::TaggedSymbol
235
+ )
236
+ INVOICE =
237
+ T.let(
238
+ :invoice,
239
+ Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::AccountingSyncRecord::RecordType::TaggedSymbol
240
+ )
241
+ TRANSACTION =
242
+ T.let(
243
+ :transaction,
244
+ Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::AccountingSyncRecord::RecordType::TaggedSymbol
245
+ )
246
+ CUSTOMER_BALANCE_TRANSACTION =
247
+ T.let(
248
+ :customer_balance_transaction,
249
+ Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::AccountingSyncRecord::RecordType::TaggedSymbol
250
+ )
251
+ CREDIT_NOTE =
252
+ T.let(
253
+ :credit_note,
254
+ Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::AccountingSyncRecord::RecordType::TaggedSymbol
255
+ )
256
+ SUBSCRIPTION =
257
+ T.let(
258
+ :subscription,
259
+ Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::AccountingSyncRecord::RecordType::TaggedSymbol
260
+ )
261
+ SALES_ORDER =
262
+ T.let(
263
+ :sales_order,
264
+ Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::AccountingSyncRecord::RecordType::TaggedSymbol
265
+ )
266
+ BLOCK =
267
+ T.let(
268
+ :block,
269
+ Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::AccountingSyncRecord::RecordType::TaggedSymbol
270
+ )
271
+
272
+ sig do
273
+ override.returns(
274
+ T::Array[
275
+ Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::AccountingSyncRecord::RecordType::TaggedSymbol
276
+ ]
277
+ )
278
+ end
279
+ def self.values
280
+ end
281
+ end
282
+ end
283
+
284
+ # The serialization style this payload was rendered in, as configured on the
285
+ # endpoint.
286
+ module PayloadStyle
287
+ extend Orb::Internal::Type::Enum
288
+
289
+ TaggedSymbol =
290
+ T.type_alias do
291
+ T.all(
292
+ Symbol,
293
+ Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::PayloadStyle
294
+ )
295
+ end
296
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
297
+
298
+ EXPANDED =
299
+ T.let(
300
+ :expanded,
301
+ Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::PayloadStyle::TaggedSymbol
302
+ )
303
+ STANDARD =
304
+ T.let(
305
+ :standard,
306
+ Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::PayloadStyle::TaggedSymbol
307
+ )
308
+
309
+ sig do
310
+ override.returns(
311
+ T::Array[
312
+ Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::PayloadStyle::TaggedSymbol
313
+ ]
314
+ )
315
+ end
316
+ def self.values
317
+ end
318
+ end
319
+
320
+ class Properties < Orb::Internal::Type::BaseModel
321
+ OrHash =
322
+ T.type_alias do
323
+ T.any(
324
+ Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::Properties,
325
+ Orb::Internal::AnyHash
326
+ )
327
+ end
328
+
329
+ sig { returns(String) }
330
+ attr_accessor :connection_type
331
+
332
+ sig { params(connection_type: String).returns(T.attached_class) }
333
+ def self.new(connection_type:)
334
+ end
335
+
336
+ sig { override.returns({ connection_type: String }) }
337
+ def to_hash
338
+ end
339
+ end
340
+
341
+ class Transaction < Orb::Internal::Type::BaseModel
342
+ OrHash =
343
+ T.type_alias do
344
+ T.any(
345
+ Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::Transaction,
346
+ Orb::Internal::AnyHash
347
+ )
348
+ end
349
+
350
+ # The ID of the payment attempt.
351
+ sig { returns(String) }
352
+ attr_accessor :id
353
+
354
+ # The amount of the payment attempt.
355
+ sig { returns(String) }
356
+ attr_accessor :amount
357
+
358
+ # The time at which the payment attempt was created.
359
+ sig { returns(Time) }
360
+ attr_accessor :created_at
361
+
362
+ # The payment provider that attempted to collect the payment.
363
+ sig do
364
+ returns(
365
+ T.nilable(
366
+ Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::Transaction::PaymentProvider::TaggedSymbol
367
+ )
368
+ )
369
+ end
370
+ attr_accessor :payment_provider
371
+
372
+ # The ID of the payment attempt in the payment provider.
373
+ sig { returns(T.nilable(String)) }
374
+ attr_accessor :payment_provider_id
375
+
376
+ # URL to the downloadable PDF version of the receipt. This field will be `null`
377
+ # for payment attempts that did not succeed.
378
+ sig { returns(T.nilable(String)) }
379
+ attr_accessor :receipt_pdf
380
+
381
+ # Whether the payment attempt succeeded.
382
+ sig { returns(T::Boolean) }
383
+ attr_accessor :succeeded
384
+
385
+ sig do
386
+ params(
387
+ id: String,
388
+ amount: String,
389
+ created_at: Time,
390
+ payment_provider:
391
+ T.nilable(
392
+ Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::Transaction::PaymentProvider::OrSymbol
393
+ ),
394
+ payment_provider_id: T.nilable(String),
395
+ receipt_pdf: T.nilable(String),
396
+ succeeded: T::Boolean
397
+ ).returns(T.attached_class)
398
+ end
399
+ def self.new(
400
+ # The ID of the payment attempt.
401
+ id:,
402
+ # The amount of the payment attempt.
403
+ amount:,
404
+ # The time at which the payment attempt was created.
405
+ created_at:,
406
+ # The payment provider that attempted to collect the payment.
407
+ payment_provider:,
408
+ # The ID of the payment attempt in the payment provider.
409
+ payment_provider_id:,
410
+ # URL to the downloadable PDF version of the receipt. This field will be `null`
411
+ # for payment attempts that did not succeed.
412
+ receipt_pdf:,
413
+ # Whether the payment attempt succeeded.
414
+ succeeded:
415
+ )
416
+ end
417
+
418
+ sig do
419
+ override.returns(
420
+ {
421
+ id: String,
422
+ amount: String,
423
+ created_at: Time,
424
+ payment_provider:
425
+ T.nilable(
426
+ Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::Transaction::PaymentProvider::TaggedSymbol
427
+ ),
428
+ payment_provider_id: T.nilable(String),
429
+ receipt_pdf: T.nilable(String),
430
+ succeeded: T::Boolean
431
+ }
432
+ )
433
+ end
434
+ def to_hash
435
+ end
436
+
437
+ # The payment provider that attempted to collect the payment.
438
+ module PaymentProvider
439
+ extend Orb::Internal::Type::Enum
440
+
441
+ TaggedSymbol =
442
+ T.type_alias do
443
+ T.all(
444
+ Symbol,
445
+ Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::Transaction::PaymentProvider
446
+ )
447
+ end
448
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
449
+
450
+ STRIPE =
451
+ T.let(
452
+ :stripe,
453
+ Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::Transaction::PaymentProvider::TaggedSymbol
454
+ )
455
+ ADYEN =
456
+ T.let(
457
+ :adyen,
458
+ Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::Transaction::PaymentProvider::TaggedSymbol
459
+ )
460
+
461
+ sig do
462
+ override.returns(
463
+ T::Array[
464
+ Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::Transaction::PaymentProvider::TaggedSymbol
465
+ ]
466
+ )
467
+ end
468
+ def self.values
469
+ end
470
+ end
471
+ end
472
+
473
+ # The event this payload describes.
474
+ module Type
475
+ extend Orb::Internal::Type::Enum
476
+
477
+ TaggedSymbol =
478
+ T.type_alias do
479
+ T.all(
480
+ Symbol,
481
+ Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::Type
482
+ )
483
+ end
484
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
485
+
486
+ TRANSACTION_ACCOUNTING_SYNC_SUCCEEDED =
487
+ T.let(
488
+ :"transaction.accounting_sync_succeeded",
489
+ Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::Type::TaggedSymbol
490
+ )
491
+
492
+ sig do
493
+ override.returns(
494
+ T::Array[
495
+ Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent::Type::TaggedSymbol
496
+ ]
497
+ )
498
+ end
499
+ def self.values
500
+ end
501
+ end
502
+ end
503
+ end
504
+ end
505
+ end
@@ -0,0 +1,107 @@
1
+ # typed: strong
2
+
3
+ module Orb
4
+ module Models
5
+ module Webhooks
6
+ # Issued when a backfill is closed and its events are reflected into usage.
7
+ module UnwrapStandardWebhookEvent
8
+ extend Orb::Internal::Type::Union
9
+
10
+ Variants =
11
+ T.type_alias do
12
+ T.any(
13
+ Orb::Webhooks::BackfillReflectedStandardWebhookEvent,
14
+ Orb::Webhooks::BackfillRevertedStandardWebhookEvent,
15
+ Orb::Webhooks::BillableMetricEditedStandardWebhookEvent,
16
+ Orb::Webhooks::CreditBlockAccountingSyncFailedStandardWebhookEvent,
17
+ Orb::Webhooks::CreditBlockAccountingSyncSucceededStandardWebhookEvent,
18
+ Orb::Webhooks::CreditNoteAccountingSyncFailedStandardWebhookEvent,
19
+ Orb::Webhooks::CreditNoteAccountingSyncSucceededStandardWebhookEvent,
20
+ Orb::Webhooks::CreditNoteIssuedStandardWebhookEvent,
21
+ Orb::Webhooks::CreditNoteMarkedAsVoidStandardWebhookEvent,
22
+ Orb::Webhooks::CustomerAccountingSyncFailedStandardWebhookEvent,
23
+ Orb::Webhooks::CustomerAccountingSyncSucceededStandardWebhookEvent,
24
+ Orb::Webhooks::CustomerBalanceTransactionCreatedStandardWebhookEvent,
25
+ Orb::Webhooks::CustomerCreatedStandardWebhookEvent,
26
+ Orb::Webhooks::CustomerCreditBalanceDepletedStandardWebhookEvent,
27
+ Orb::Webhooks::CustomerCreditBalanceDroppedStandardWebhookEvent,
28
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent,
29
+ Orb::Webhooks::CustomerCreditLedgerIncrementedStandardWebhookEvent,
30
+ Orb::Webhooks::CustomerEditedStandardWebhookEvent,
31
+ Orb::Webhooks::DataExportsTransferErrorStandardWebhookEvent,
32
+ Orb::Webhooks::DataExportsTransferSuccessStandardWebhookEvent,
33
+ Orb::Webhooks::EventUnmatchedEventStandardWebhookEvent,
34
+ Orb::Webhooks::IngestionUnmatchedCustomerIDsStandardWebhookEvent,
35
+ Orb::Webhooks::InvoiceAccountingSyncFailedStandardWebhookEvent,
36
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent,
37
+ Orb::Webhooks::InvoiceAutomationScheduleStepExecutedStandardWebhookEvent,
38
+ Orb::Webhooks::InvoiceCostDataExportedStandardWebhookEvent,
39
+ Orb::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent,
40
+ Orb::Webhooks::InvoiceDunningScheduleEndedStandardWebhookEvent,
41
+ Orb::Webhooks::InvoiceDunningScheduleResetStandardWebhookEvent,
42
+ Orb::Webhooks::InvoiceDunningScheduleStepExecutedStandardWebhookEvent,
43
+ Orb::Webhooks::InvoiceEditedStandardWebhookEvent,
44
+ Orb::Webhooks::InvoiceInvoiceDateElapsedStandardWebhookEvent,
45
+ Orb::Webhooks::InvoiceIssueFailedStandardWebhookEvent,
46
+ Orb::Webhooks::InvoiceIssuedStandardWebhookEvent,
47
+ Orb::Webhooks::InvoiceIssuedSummaryStandardWebhookEvent,
48
+ Orb::Webhooks::InvoiceManuallyMarkedAsPaidStandardWebhookEvent,
49
+ Orb::Webhooks::InvoiceManuallyMarkedAsVoidStandardWebhookEvent,
50
+ Orb::Webhooks::InvoicePaymentFailedStandardWebhookEvent,
51
+ Orb::Webhooks::InvoicePaymentProcessingStandardWebhookEvent,
52
+ Orb::Webhooks::InvoicePaymentSucceededStandardWebhookEvent,
53
+ Orb::Webhooks::InvoiceSyncFailedStandardWebhookEvent,
54
+ Orb::Webhooks::InvoiceSyncSucceededStandardWebhookEvent,
55
+ Orb::Webhooks::InvoiceUndoMarkAsPaidStandardWebhookEvent,
56
+ Orb::Webhooks::InvoiceDueDateRecalculationCanceledStandardWebhookEvent,
57
+ Orb::Webhooks::InvoiceDueDateRecalculationCompletedStandardWebhookEvent,
58
+ Orb::Webhooks::InvoiceDueDateRecalculationStartedStandardWebhookEvent,
59
+ Orb::Webhooks::MetricEventsDroppedByWatermarkStandardWebhookEvent,
60
+ Orb::Webhooks::PaymentMethodCreatedStandardWebhookEvent,
61
+ Orb::Webhooks::PaymentMethodDeletedStandardWebhookEvent,
62
+ Orb::Webhooks::PlanCreatedStandardWebhookEvent,
63
+ Orb::Webhooks::PlanDefaultVersionSetStandardWebhookEvent,
64
+ Orb::Webhooks::PlanEditedStandardWebhookEvent,
65
+ Orb::Webhooks::PlanVersionCreatedStandardWebhookEvent,
66
+ Orb::Webhooks::PriceEditedStandardWebhookEvent,
67
+ Orb::Webhooks::ResourceEventTestStandardWebhookEvent,
68
+ Orb::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent,
69
+ Orb::Webhooks::SalesOrderAccountingSyncSucceededStandardWebhookEvent,
70
+ Orb::Webhooks::SubscriptionAccountingSyncFailedStandardWebhookEvent,
71
+ Orb::Webhooks::SubscriptionAccountingSyncSucceededStandardWebhookEvent,
72
+ Orb::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent,
73
+ Orb::Webhooks::SubscriptionCancellationScheduledStandardWebhookEvent,
74
+ Orb::Webhooks::SubscriptionCancellationUnscheduledStandardWebhookEvent,
75
+ Orb::Webhooks::SubscriptionCostExceededStandardWebhookEvent,
76
+ Orb::Webhooks::SubscriptionCreatedStandardWebhookEvent,
77
+ Orb::Webhooks::SubscriptionEditedStandardWebhookEvent,
78
+ Orb::Webhooks::SubscriptionEndedStandardWebhookEvent,
79
+ Orb::Webhooks::SubscriptionFixedFeeQuantityUpdatedStandardWebhookEvent,
80
+ Orb::Webhooks::SubscriptionGroupedCostExceededStandardWebhookEvent,
81
+ Orb::Webhooks::SubscriptionInvoicingThresholdExceededStandardWebhookEvent,
82
+ Orb::Webhooks::SubscriptionLicenseAllocationResetStandardWebhookEvent,
83
+ Orb::Webhooks::SubscriptionLicenseBalanceThresholdReachedStandardWebhookEvent,
84
+ Orb::Webhooks::SubscriptionPlanChangeScheduledStandardWebhookEvent,
85
+ Orb::Webhooks::SubscriptionPlanChangedStandardWebhookEvent,
86
+ Orb::Webhooks::SubscriptionPlanVersionChangeScheduledStandardWebhookEvent,
87
+ Orb::Webhooks::SubscriptionPlanVersionChangedStandardWebhookEvent,
88
+ Orb::Webhooks::SubscriptionSpendExceededStandardWebhookEvent,
89
+ Orb::Webhooks::SubscriptionStartedStandardWebhookEvent,
90
+ Orb::Webhooks::SubscriptionTrialEndedStandardWebhookEvent,
91
+ Orb::Webhooks::SubscriptionUsageExceededStandardWebhookEvent,
92
+ Orb::Webhooks::TransactionAccountingSyncFailedStandardWebhookEvent,
93
+ Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent
94
+ )
95
+ end
96
+
97
+ sig do
98
+ override.returns(
99
+ T::Array[Orb::Webhooks::UnwrapStandardWebhookEvent::Variants]
100
+ )
101
+ end
102
+ def self.variants
103
+ end
104
+ end
105
+ end
106
+ end
107
+ end
data/rbi/orb/models.rbi CHANGED
@@ -914,5 +914,7 @@ module Orb
914
914
 
915
915
  WebhookEndpointWithSecret = Orb::Models::WebhookEndpointWithSecret
916
916
 
917
+ Webhooks = Orb::Models::Webhooks
918
+
917
919
  WebhookUnwrapParams = Orb::Models::WebhookUnwrapParams
918
920
  end
@@ -36,28 +36,38 @@ module Orb
36
36
  )
37
37
  end
38
38
 
39
- # This endpoint allows you to update the `metadata` property on a metric. If you
40
- # pass `null` for the metadata value, it will clear any existing metadata for that
41
- # invoice.
39
+ # This endpoint allows you to update the `name`, `description`, and `metadata`
40
+ # properties on a metric. Fields left out of the request are not changed, and
41
+ # `name` cannot be empty. If you pass `null` for the metadata value, it will clear
42
+ # any existing metadata for that metric.
42
43
  sig do
43
44
  params(
44
45
  metric_id: String,
46
+ description: T.nilable(String),
45
47
  metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
48
+ name: T.nilable(String),
46
49
  request_options: Orb::RequestOptions::OrHash
47
50
  ).returns(Orb::BillableMetric)
48
51
  end
49
52
  def update(
50
53
  metric_id,
54
+ # A description of the metric.
55
+ description: nil,
51
56
  # User-specified key/value pairs for the resource. Individual keys can be removed
52
57
  # by setting the value to `null`, and the entire metadata mapping can be cleared
53
58
  # by setting `metadata` to `null`.
54
59
  metadata: nil,
60
+ # The name of the metric.
61
+ name: nil,
55
62
  request_options: {}
56
63
  )
57
64
  end
58
65
 
59
66
  # This endpoint is used to list [metrics](/core-concepts#metric). It returns
60
67
  # information about the metrics including its name, description, and item.
68
+ #
69
+ # Pass `status` to only return metrics with that status, e.g. `status=active` to
70
+ # leave out archived metrics.
61
71
  sig do
62
72
  params(
63
73
  created_at_gt: T.nilable(Time),
@@ -66,6 +76,7 @@ module Orb
66
76
  created_at_lte: T.nilable(Time),
67
77
  cursor: T.nilable(String),
68
78
  limit: Integer,
79
+ status: T.nilable(Orb::MetricListParams::Status::OrSymbol),
69
80
  request_options: Orb::RequestOptions::OrHash
70
81
  ).returns(Orb::Internal::Page[Orb::BillableMetric])
71
82
  end
@@ -79,6 +90,8 @@ module Orb
79
90
  cursor: nil,
80
91
  # The number of items to fetch. Defaults to 20.
81
92
  limit: nil,
93
+ # The metric status to filter to ('active', 'archived', or 'draft').
94
+ status: nil,
82
95
  request_options: {}
83
96
  )
84
97
  end