orb-billing 1.43.0 → 1.45.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 (315) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +15 -0
  3. data/README.md +1 -1
  4. data/lib/orb/client.rb +6 -0
  5. data/lib/orb/models/alert_create_for_plan_params.rb +156 -0
  6. data/lib/orb/models/backfill_reflected_webhook_event.rb +24 -1
  7. data/lib/orb/models/backfill_reverted_webhook_event.rb +24 -1
  8. data/lib/orb/models/billable_metric_edited_webhook_event.rb +24 -1
  9. data/lib/orb/models/credit_block_accounting_sync_failed_webhook_event.rb +27 -1
  10. data/lib/orb/models/credit_block_accounting_sync_succeeded_webhook_event.rb +27 -1
  11. data/lib/orb/models/credit_note_accounting_sync_failed_webhook_event.rb +24 -1
  12. data/lib/orb/models/credit_note_accounting_sync_succeeded_webhook_event.rb +24 -1
  13. data/lib/orb/models/credit_note_issued_webhook_event.rb +24 -1
  14. data/lib/orb/models/credit_note_marked_as_void_webhook_event.rb +24 -1
  15. data/lib/orb/models/customer_accounting_sync_failed_webhook_event.rb +24 -1
  16. data/lib/orb/models/customer_accounting_sync_succeeded_webhook_event.rb +24 -1
  17. data/lib/orb/models/customer_balance_transaction_created_webhook_event.rb +24 -1
  18. data/lib/orb/models/customer_created_webhook_event.rb +24 -1
  19. data/lib/orb/models/customer_credit_balance_depleted_webhook_event.rb +24 -1
  20. data/lib/orb/models/customer_credit_balance_dropped_webhook_event.rb +24 -1
  21. data/lib/orb/models/customer_credit_balance_recovered_webhook_event.rb +24 -1
  22. data/lib/orb/models/customer_credit_ledger_incremented_webhook_event.rb +24 -1
  23. data/lib/orb/models/customer_edited_webhook_event.rb +24 -1
  24. data/lib/orb/models/data_exports_transfer_error_webhook_event.rb +27 -1
  25. data/lib/orb/models/data_exports_transfer_success_webhook_event.rb +27 -1
  26. data/lib/orb/models/dimensional_price_groups/price_create_params.rb +147 -0
  27. data/lib/orb/models/dimensional_price_groups/price_create_response.rb +19 -0
  28. data/lib/orb/models/dimensional_price_groups/price_list_params.rb +65 -0
  29. data/lib/orb/models/event_unmatched_event_webhook_event.rb +27 -1
  30. data/lib/orb/models/ingestion_unmatched_customer_ids_webhook_event.rb +27 -1
  31. data/lib/orb/models/invoice_accounting_sync_failed_webhook_event.rb +24 -1
  32. data/lib/orb/models/invoice_accounting_sync_succeeded_webhook_event.rb +24 -1
  33. data/lib/orb/models/invoice_automation_schedule_step_executed_webhook_event.rb +24 -1
  34. data/lib/orb/models/invoice_cost_data_exported_webhook_event.rb +27 -1
  35. data/lib/orb/models/invoice_due_date_recalculation_canceled_webhook_event.rb +27 -1
  36. data/lib/orb/models/invoice_due_date_recalculation_completed_webhook_event.rb +28 -1
  37. data/lib/orb/models/invoice_due_date_recalculation_started_webhook_event.rb +27 -1
  38. data/lib/orb/models/invoice_dunning_schedule_created_webhook_event.rb +24 -1
  39. data/lib/orb/models/invoice_dunning_schedule_ended_webhook_event.rb +24 -1
  40. data/lib/orb/models/invoice_dunning_schedule_reset_webhook_event.rb +24 -1
  41. data/lib/orb/models/invoice_dunning_schedule_step_executed_webhook_event.rb +24 -1
  42. data/lib/orb/models/invoice_edited_webhook_event.rb +24 -1
  43. data/lib/orb/models/invoice_invoice_date_elapsed_webhook_event.rb +27 -1
  44. data/lib/orb/models/invoice_issue_failed_webhook_event.rb +24 -1
  45. data/lib/orb/models/invoice_issued_summary_webhook_event.rb +27 -1
  46. data/lib/orb/models/invoice_issued_webhook_event.rb +24 -1
  47. data/lib/orb/models/invoice_manually_marked_as_paid_webhook_event.rb +24 -1
  48. data/lib/orb/models/invoice_manually_marked_as_void_webhook_event.rb +24 -1
  49. data/lib/orb/models/invoice_payment_failed_webhook_event.rb +24 -1
  50. data/lib/orb/models/invoice_payment_processing_webhook_event.rb +24 -1
  51. data/lib/orb/models/invoice_payment_succeeded_webhook_event.rb +24 -1
  52. data/lib/orb/models/invoice_sync_failed_webhook_event.rb +24 -1
  53. data/lib/orb/models/invoice_sync_succeeded_webhook_event.rb +24 -1
  54. data/lib/orb/models/invoice_undo_mark_as_paid_webhook_event.rb +24 -1
  55. data/lib/orb/models/metric_events_dropped_by_watermark_webhook_event.rb +24 -1
  56. data/lib/orb/models/payment_method_created_webhook_event.rb +24 -1
  57. data/lib/orb/models/payment_method_deleted_webhook_event.rb +24 -1
  58. data/lib/orb/models/plan_created_webhook_event.rb +117 -0
  59. data/lib/orb/models/plan_default_version_set_webhook_event.rb +27 -1
  60. data/lib/orb/models/plan_edited_webhook_event.rb +154 -0
  61. data/lib/orb/models/plan_version_created_webhook_event.rb +27 -1
  62. data/lib/orb/models/price_edited_webhook_event.rb +24 -1
  63. data/lib/orb/models/resource_event_test_webhook_event.rb +27 -1
  64. data/lib/orb/models/sales_order_accounting_sync_failed_webhook_event.rb +24 -1
  65. data/lib/orb/models/sales_order_accounting_sync_succeeded_webhook_event.rb +24 -1
  66. data/lib/orb/models/subscription_accounting_sync_failed_webhook_event.rb +24 -1
  67. data/lib/orb/models/subscription_accounting_sync_succeeded_webhook_event.rb +24 -1
  68. data/lib/orb/models/subscription_alert_disabled_webhook_event.rb +24 -1
  69. data/lib/orb/models/subscription_cancellation_scheduled_webhook_event.rb +24 -1
  70. data/lib/orb/models/subscription_cancellation_unscheduled_webhook_event.rb +24 -1
  71. data/lib/orb/models/subscription_cost_exceeded_webhook_event.rb +24 -1
  72. data/lib/orb/models/subscription_created_webhook_event.rb +24 -1
  73. data/lib/orb/models/subscription_edited_webhook_event.rb +24 -1
  74. data/lib/orb/models/subscription_ended_webhook_event.rb +24 -1
  75. data/lib/orb/models/subscription_fixed_fee_quantity_updated_webhook_event.rb +24 -1
  76. data/lib/orb/models/subscription_grouped_cost_exceeded_webhook_event.rb +24 -1
  77. data/lib/orb/models/subscription_invoicing_threshold_exceeded_webhook_event.rb +25 -1
  78. data/lib/orb/models/subscription_license_allocation_reset_webhook_event.rb +24 -1
  79. data/lib/orb/models/subscription_license_balance_threshold_reached_webhook_event.rb +25 -1
  80. data/lib/orb/models/subscription_plan_change_scheduled_webhook_event.rb +24 -1
  81. data/lib/orb/models/subscription_plan_changed_webhook_event.rb +24 -1
  82. data/lib/orb/models/subscription_plan_version_change_scheduled_webhook_event.rb +25 -1
  83. data/lib/orb/models/subscription_plan_version_changed_webhook_event.rb +24 -1
  84. data/lib/orb/models/subscription_spend_exceeded_webhook_event.rb +24 -1
  85. data/lib/orb/models/subscription_started_webhook_event.rb +24 -1
  86. data/lib/orb/models/subscription_trial_ended_webhook_event.rb +24 -1
  87. data/lib/orb/models/subscription_usage_exceeded_webhook_event.rb +24 -1
  88. data/lib/orb/models/tax_amount.rb +32 -1
  89. data/lib/orb/models/transaction_accounting_sync_failed_webhook_event.rb +27 -1
  90. data/lib/orb/models/transaction_accounting_sync_succeeded_webhook_event.rb +27 -1
  91. data/lib/orb/models/unwrap_webhook_event.rb +7 -1
  92. data/lib/orb/models/webhook_endpoint.rb +56 -0
  93. data/lib/orb/models/webhook_endpoint_create_params.rb +34 -0
  94. data/lib/orb/models/webhook_endpoint_delete_params.rb +20 -0
  95. data/lib/orb/models/webhook_endpoint_disable_params.rb +20 -0
  96. data/lib/orb/models/webhook_endpoint_enable_params.rb +20 -0
  97. data/lib/orb/models/webhook_endpoint_list_params.rb +34 -0
  98. data/lib/orb/models/webhook_endpoint_retrieve_params.rb +20 -0
  99. data/lib/orb/models/webhook_endpoint_update_params.rb +41 -0
  100. data/lib/orb/models/webhook_endpoint_with_secret.rb +65 -0
  101. data/lib/orb/models.rb +24 -0
  102. data/lib/orb/resources/alerts.rb +55 -0
  103. data/lib/orb/resources/dimensional_price_groups/prices.rb +87 -0
  104. data/lib/orb/resources/dimensional_price_groups.rb +4 -0
  105. data/lib/orb/resources/webhook_endpoints.rb +183 -0
  106. data/lib/orb/resources/webhooks.rb +1 -1
  107. data/lib/orb/version.rb +1 -1
  108. data/lib/orb.rb +17 -0
  109. data/rbi/orb/client.rbi +5 -0
  110. data/rbi/orb/models/alert_create_for_plan_params.rbi +290 -0
  111. data/rbi/orb/models/backfill_reflected_webhook_event.rbi +47 -0
  112. data/rbi/orb/models/backfill_reverted_webhook_event.rbi +47 -0
  113. data/rbi/orb/models/billable_metric_edited_webhook_event.rbi +49 -0
  114. data/rbi/orb/models/credit_block_accounting_sync_failed_webhook_event.rbi +52 -0
  115. data/rbi/orb/models/credit_block_accounting_sync_succeeded_webhook_event.rbi +52 -0
  116. data/rbi/orb/models/credit_note_accounting_sync_failed_webhook_event.rbi +52 -0
  117. data/rbi/orb/models/credit_note_accounting_sync_succeeded_webhook_event.rbi +52 -0
  118. data/rbi/orb/models/credit_note_issued_webhook_event.rbi +47 -0
  119. data/rbi/orb/models/credit_note_marked_as_void_webhook_event.rbi +49 -0
  120. data/rbi/orb/models/customer_accounting_sync_failed_webhook_event.rbi +52 -0
  121. data/rbi/orb/models/customer_accounting_sync_succeeded_webhook_event.rbi +52 -0
  122. data/rbi/orb/models/customer_balance_transaction_created_webhook_event.rbi +52 -0
  123. data/rbi/orb/models/customer_created_webhook_event.rbi +47 -0
  124. data/rbi/orb/models/customer_credit_balance_depleted_webhook_event.rbi +52 -0
  125. data/rbi/orb/models/customer_credit_balance_dropped_webhook_event.rbi +52 -0
  126. data/rbi/orb/models/customer_credit_balance_recovered_webhook_event.rbi +52 -0
  127. data/rbi/orb/models/customer_credit_ledger_incremented_webhook_event.rbi +52 -0
  128. data/rbi/orb/models/customer_edited_webhook_event.rbi +47 -0
  129. data/rbi/orb/models/data_exports_transfer_error_webhook_event.rbi +52 -0
  130. data/rbi/orb/models/data_exports_transfer_success_webhook_event.rbi +52 -0
  131. data/rbi/orb/models/dimensional_price_groups/price_create_params.rbi +298 -0
  132. data/rbi/orb/models/dimensional_price_groups/price_create_response.rbi +76 -0
  133. data/rbi/orb/models/dimensional_price_groups/price_list_params.rbi +134 -0
  134. data/rbi/orb/models/event_unmatched_event_webhook_event.rbi +49 -0
  135. data/rbi/orb/models/ingestion_unmatched_customer_ids_webhook_event.rbi +52 -0
  136. data/rbi/orb/models/invoice_accounting_sync_failed_webhook_event.rbi +52 -0
  137. data/rbi/orb/models/invoice_accounting_sync_succeeded_webhook_event.rbi +52 -0
  138. data/rbi/orb/models/invoice_automation_schedule_step_executed_webhook_event.rbi +52 -0
  139. data/rbi/orb/models/invoice_cost_data_exported_webhook_event.rbi +52 -0
  140. data/rbi/orb/models/invoice_due_date_recalculation_canceled_webhook_event.rbi +52 -0
  141. data/rbi/orb/models/invoice_due_date_recalculation_completed_webhook_event.rbi +52 -0
  142. data/rbi/orb/models/invoice_due_date_recalculation_started_webhook_event.rbi +52 -0
  143. data/rbi/orb/models/invoice_dunning_schedule_created_webhook_event.rbi +52 -0
  144. data/rbi/orb/models/invoice_dunning_schedule_ended_webhook_event.rbi +52 -0
  145. data/rbi/orb/models/invoice_dunning_schedule_reset_webhook_event.rbi +52 -0
  146. data/rbi/orb/models/invoice_dunning_schedule_step_executed_webhook_event.rbi +52 -0
  147. data/rbi/orb/models/invoice_edited_webhook_event.rbi +44 -0
  148. data/rbi/orb/models/invoice_invoice_date_elapsed_webhook_event.rbi +52 -0
  149. data/rbi/orb/models/invoice_issue_failed_webhook_event.rbi +47 -0
  150. data/rbi/orb/models/invoice_issued_summary_webhook_event.rbi +49 -0
  151. data/rbi/orb/models/invoice_issued_webhook_event.rbi +44 -0
  152. data/rbi/orb/models/invoice_manually_marked_as_paid_webhook_event.rbi +52 -0
  153. data/rbi/orb/models/invoice_manually_marked_as_void_webhook_event.rbi +52 -0
  154. data/rbi/orb/models/invoice_payment_failed_webhook_event.rbi +49 -0
  155. data/rbi/orb/models/invoice_payment_processing_webhook_event.rbi +52 -0
  156. data/rbi/orb/models/invoice_payment_succeeded_webhook_event.rbi +52 -0
  157. data/rbi/orb/models/invoice_sync_failed_webhook_event.rbi +47 -0
  158. data/rbi/orb/models/invoice_sync_succeeded_webhook_event.rbi +49 -0
  159. data/rbi/orb/models/invoice_undo_mark_as_paid_webhook_event.rbi +49 -0
  160. data/rbi/orb/models/metric_events_dropped_by_watermark_webhook_event.rbi +52 -0
  161. data/rbi/orb/models/payment_method_created_webhook_event.rbi +49 -0
  162. data/rbi/orb/models/payment_method_deleted_webhook_event.rbi +49 -0
  163. data/rbi/orb/models/plan_created_webhook_event.rbi +182 -0
  164. data/rbi/orb/models/plan_default_version_set_webhook_event.rbi +49 -0
  165. data/rbi/orb/models/plan_edited_webhook_event.rbi +301 -0
  166. data/rbi/orb/models/plan_version_created_webhook_event.rbi +47 -0
  167. data/rbi/orb/models/price_edited_webhook_event.rbi +42 -0
  168. data/rbi/orb/models/resource_event_test_webhook_event.rbi +47 -0
  169. data/rbi/orb/models/sales_order_accounting_sync_failed_webhook_event.rbi +52 -0
  170. data/rbi/orb/models/sales_order_accounting_sync_succeeded_webhook_event.rbi +52 -0
  171. data/rbi/orb/models/subscription_accounting_sync_failed_webhook_event.rbi +52 -0
  172. data/rbi/orb/models/subscription_accounting_sync_succeeded_webhook_event.rbi +52 -0
  173. data/rbi/orb/models/subscription_alert_disabled_webhook_event.rbi +52 -0
  174. data/rbi/orb/models/subscription_cancellation_scheduled_webhook_event.rbi +52 -0
  175. data/rbi/orb/models/subscription_cancellation_unscheduled_webhook_event.rbi +52 -0
  176. data/rbi/orb/models/subscription_cost_exceeded_webhook_event.rbi +52 -0
  177. data/rbi/orb/models/subscription_created_webhook_event.rbi +49 -0
  178. data/rbi/orb/models/subscription_edited_webhook_event.rbi +47 -0
  179. data/rbi/orb/models/subscription_ended_webhook_event.rbi +47 -0
  180. data/rbi/orb/models/subscription_fixed_fee_quantity_updated_webhook_event.rbi +52 -0
  181. data/rbi/orb/models/subscription_grouped_cost_exceeded_webhook_event.rbi +52 -0
  182. data/rbi/orb/models/subscription_invoicing_threshold_exceeded_webhook_event.rbi +52 -0
  183. data/rbi/orb/models/subscription_license_allocation_reset_webhook_event.rbi +52 -0
  184. data/rbi/orb/models/subscription_license_balance_threshold_reached_webhook_event.rbi +52 -0
  185. data/rbi/orb/models/subscription_plan_change_scheduled_webhook_event.rbi +52 -0
  186. data/rbi/orb/models/subscription_plan_changed_webhook_event.rbi +52 -0
  187. data/rbi/orb/models/subscription_plan_version_change_scheduled_webhook_event.rbi +52 -0
  188. data/rbi/orb/models/subscription_plan_version_changed_webhook_event.rbi +52 -0
  189. data/rbi/orb/models/subscription_spend_exceeded_webhook_event.rbi +52 -0
  190. data/rbi/orb/models/subscription_started_webhook_event.rbi +49 -0
  191. data/rbi/orb/models/subscription_trial_ended_webhook_event.rbi +49 -0
  192. data/rbi/orb/models/subscription_usage_exceeded_webhook_event.rbi +52 -0
  193. data/rbi/orb/models/tax_amount.rbi +41 -3
  194. data/rbi/orb/models/transaction_accounting_sync_failed_webhook_event.rbi +52 -0
  195. data/rbi/orb/models/transaction_accounting_sync_succeeded_webhook_event.rbi +52 -0
  196. data/rbi/orb/models/unwrap_webhook_event.rbi +2 -0
  197. data/rbi/orb/models/webhook_endpoint.rbi +71 -0
  198. data/rbi/orb/models/webhook_endpoint_create_params.rbi +53 -0
  199. data/rbi/orb/models/webhook_endpoint_delete_params.rbi +35 -0
  200. data/rbi/orb/models/webhook_endpoint_disable_params.rbi +35 -0
  201. data/rbi/orb/models/webhook_endpoint_enable_params.rbi +35 -0
  202. data/rbi/orb/models/webhook_endpoint_list_params.rbi +56 -0
  203. data/rbi/orb/models/webhook_endpoint_retrieve_params.rbi +35 -0
  204. data/rbi/orb/models/webhook_endpoint_update_params.rbi +59 -0
  205. data/rbi/orb/models/webhook_endpoint_with_secret.rbi +83 -0
  206. data/rbi/orb/models.rbi +24 -0
  207. data/rbi/orb/resources/alerts.rbi +59 -0
  208. data/rbi/orb/resources/dimensional_price_groups/prices.rbi +82 -0
  209. data/rbi/orb/resources/dimensional_price_groups.rbi +3 -0
  210. data/rbi/orb/resources/webhook_endpoints.rbi +116 -0
  211. data/rbi/orb/resources/webhooks.rbi +2 -0
  212. data/sig/orb/client.rbs +2 -0
  213. data/sig/orb/models/alert_create_for_plan_params.rbs +126 -0
  214. data/sig/orb/models/backfill_reflected_webhook_event.rbs +16 -0
  215. data/sig/orb/models/backfill_reverted_webhook_event.rbs +16 -0
  216. data/sig/orb/models/billable_metric_edited_webhook_event.rbs +16 -0
  217. data/sig/orb/models/credit_block_accounting_sync_failed_webhook_event.rbs +16 -0
  218. data/sig/orb/models/credit_block_accounting_sync_succeeded_webhook_event.rbs +16 -0
  219. data/sig/orb/models/credit_note_accounting_sync_failed_webhook_event.rbs +16 -0
  220. data/sig/orb/models/credit_note_accounting_sync_succeeded_webhook_event.rbs +16 -0
  221. data/sig/orb/models/credit_note_issued_webhook_event.rbs +16 -0
  222. data/sig/orb/models/credit_note_marked_as_void_webhook_event.rbs +16 -0
  223. data/sig/orb/models/customer_accounting_sync_failed_webhook_event.rbs +16 -0
  224. data/sig/orb/models/customer_accounting_sync_succeeded_webhook_event.rbs +16 -0
  225. data/sig/orb/models/customer_balance_transaction_created_webhook_event.rbs +16 -0
  226. data/sig/orb/models/customer_created_webhook_event.rbs +16 -0
  227. data/sig/orb/models/customer_credit_balance_depleted_webhook_event.rbs +16 -0
  228. data/sig/orb/models/customer_credit_balance_dropped_webhook_event.rbs +16 -0
  229. data/sig/orb/models/customer_credit_balance_recovered_webhook_event.rbs +16 -0
  230. data/sig/orb/models/customer_credit_ledger_incremented_webhook_event.rbs +16 -0
  231. data/sig/orb/models/customer_edited_webhook_event.rbs +16 -0
  232. data/sig/orb/models/data_exports_transfer_error_webhook_event.rbs +16 -0
  233. data/sig/orb/models/data_exports_transfer_success_webhook_event.rbs +16 -0
  234. data/sig/orb/models/dimensional_price_groups/price_create_params.rbs +123 -0
  235. data/sig/orb/models/dimensional_price_groups/price_create_response.rbs +15 -0
  236. data/sig/orb/models/dimensional_price_groups/price_list_params.rbs +61 -0
  237. data/sig/orb/models/event_unmatched_event_webhook_event.rbs +16 -0
  238. data/sig/orb/models/ingestion_unmatched_customer_ids_webhook_event.rbs +16 -0
  239. data/sig/orb/models/invoice_accounting_sync_failed_webhook_event.rbs +16 -0
  240. data/sig/orb/models/invoice_accounting_sync_succeeded_webhook_event.rbs +16 -0
  241. data/sig/orb/models/invoice_automation_schedule_step_executed_webhook_event.rbs +16 -0
  242. data/sig/orb/models/invoice_cost_data_exported_webhook_event.rbs +16 -0
  243. data/sig/orb/models/invoice_due_date_recalculation_canceled_webhook_event.rbs +16 -0
  244. data/sig/orb/models/invoice_due_date_recalculation_completed_webhook_event.rbs +16 -0
  245. data/sig/orb/models/invoice_due_date_recalculation_started_webhook_event.rbs +16 -0
  246. data/sig/orb/models/invoice_dunning_schedule_created_webhook_event.rbs +16 -0
  247. data/sig/orb/models/invoice_dunning_schedule_ended_webhook_event.rbs +16 -0
  248. data/sig/orb/models/invoice_dunning_schedule_reset_webhook_event.rbs +16 -0
  249. data/sig/orb/models/invoice_dunning_schedule_step_executed_webhook_event.rbs +16 -0
  250. data/sig/orb/models/invoice_edited_webhook_event.rbs +16 -0
  251. data/sig/orb/models/invoice_invoice_date_elapsed_webhook_event.rbs +16 -0
  252. data/sig/orb/models/invoice_issue_failed_webhook_event.rbs +16 -0
  253. data/sig/orb/models/invoice_issued_summary_webhook_event.rbs +16 -0
  254. data/sig/orb/models/invoice_issued_webhook_event.rbs +16 -0
  255. data/sig/orb/models/invoice_manually_marked_as_paid_webhook_event.rbs +16 -0
  256. data/sig/orb/models/invoice_manually_marked_as_void_webhook_event.rbs +16 -0
  257. data/sig/orb/models/invoice_payment_failed_webhook_event.rbs +16 -0
  258. data/sig/orb/models/invoice_payment_processing_webhook_event.rbs +16 -0
  259. data/sig/orb/models/invoice_payment_succeeded_webhook_event.rbs +16 -0
  260. data/sig/orb/models/invoice_sync_failed_webhook_event.rbs +16 -0
  261. data/sig/orb/models/invoice_sync_succeeded_webhook_event.rbs +16 -0
  262. data/sig/orb/models/invoice_undo_mark_as_paid_webhook_event.rbs +16 -0
  263. data/sig/orb/models/metric_events_dropped_by_watermark_webhook_event.rbs +16 -0
  264. data/sig/orb/models/payment_method_created_webhook_event.rbs +16 -0
  265. data/sig/orb/models/payment_method_deleted_webhook_event.rbs +16 -0
  266. data/sig/orb/models/plan_created_webhook_event.rbs +88 -0
  267. data/sig/orb/models/plan_default_version_set_webhook_event.rbs +16 -0
  268. data/sig/orb/models/plan_edited_webhook_event.rbs +132 -0
  269. data/sig/orb/models/plan_version_created_webhook_event.rbs +16 -0
  270. data/sig/orb/models/price_edited_webhook_event.rbs +16 -0
  271. data/sig/orb/models/resource_event_test_webhook_event.rbs +16 -0
  272. data/sig/orb/models/sales_order_accounting_sync_failed_webhook_event.rbs +16 -0
  273. data/sig/orb/models/sales_order_accounting_sync_succeeded_webhook_event.rbs +16 -0
  274. data/sig/orb/models/subscription_accounting_sync_failed_webhook_event.rbs +16 -0
  275. data/sig/orb/models/subscription_accounting_sync_succeeded_webhook_event.rbs +16 -0
  276. data/sig/orb/models/subscription_alert_disabled_webhook_event.rbs +16 -0
  277. data/sig/orb/models/subscription_cancellation_scheduled_webhook_event.rbs +16 -0
  278. data/sig/orb/models/subscription_cancellation_unscheduled_webhook_event.rbs +16 -0
  279. data/sig/orb/models/subscription_cost_exceeded_webhook_event.rbs +16 -0
  280. data/sig/orb/models/subscription_created_webhook_event.rbs +16 -0
  281. data/sig/orb/models/subscription_edited_webhook_event.rbs +16 -0
  282. data/sig/orb/models/subscription_ended_webhook_event.rbs +16 -0
  283. data/sig/orb/models/subscription_fixed_fee_quantity_updated_webhook_event.rbs +16 -0
  284. data/sig/orb/models/subscription_grouped_cost_exceeded_webhook_event.rbs +16 -0
  285. data/sig/orb/models/subscription_invoicing_threshold_exceeded_webhook_event.rbs +16 -0
  286. data/sig/orb/models/subscription_license_allocation_reset_webhook_event.rbs +16 -0
  287. data/sig/orb/models/subscription_license_balance_threshold_reached_webhook_event.rbs +16 -0
  288. data/sig/orb/models/subscription_plan_change_scheduled_webhook_event.rbs +16 -0
  289. data/sig/orb/models/subscription_plan_changed_webhook_event.rbs +16 -0
  290. data/sig/orb/models/subscription_plan_version_change_scheduled_webhook_event.rbs +16 -0
  291. data/sig/orb/models/subscription_plan_version_changed_webhook_event.rbs +16 -0
  292. data/sig/orb/models/subscription_spend_exceeded_webhook_event.rbs +16 -0
  293. data/sig/orb/models/subscription_started_webhook_event.rbs +16 -0
  294. data/sig/orb/models/subscription_trial_ended_webhook_event.rbs +16 -0
  295. data/sig/orb/models/subscription_usage_exceeded_webhook_event.rbs +16 -0
  296. data/sig/orb/models/tax_amount.rbs +31 -3
  297. data/sig/orb/models/transaction_accounting_sync_failed_webhook_event.rbs +16 -0
  298. data/sig/orb/models/transaction_accounting_sync_succeeded_webhook_event.rbs +16 -0
  299. data/sig/orb/models/unwrap_webhook_event.rbs +2 -0
  300. data/sig/orb/models/webhook_endpoint.rbs +40 -0
  301. data/sig/orb/models/webhook_endpoint_create_params.rbs +28 -0
  302. data/sig/orb/models/webhook_endpoint_delete_params.rbs +23 -0
  303. data/sig/orb/models/webhook_endpoint_disable_params.rbs +23 -0
  304. data/sig/orb/models/webhook_endpoint_enable_params.rbs +23 -0
  305. data/sig/orb/models/webhook_endpoint_list_params.rbs +30 -0
  306. data/sig/orb/models/webhook_endpoint_retrieve_params.rbs +23 -0
  307. data/sig/orb/models/webhook_endpoint_update_params.rbs +36 -0
  308. data/sig/orb/models/webhook_endpoint_with_secret.rbs +45 -0
  309. data/sig/orb/models.rbs +24 -0
  310. data/sig/orb/resources/alerts.rbs +12 -0
  311. data/sig/orb/resources/dimensional_price_groups/prices.rbs +28 -0
  312. data/sig/orb/resources/dimensional_price_groups.rbs +2 -0
  313. data/sig/orb/resources/webhook_endpoints.rbs +46 -0
  314. data/sig/orb/resources/webhooks.rbs +2 -0
  315. metadata +52 -1
@@ -15,6 +15,13 @@ module Orb
15
15
  # @return [Time]
16
16
  required :created_at, Time
17
17
 
18
+ # @!attribute payload_style
19
+ # The serialization style this payload was rendered in, as configured on the
20
+ # endpoint.
21
+ #
22
+ # @return [Symbol, Orb::Models::SubscriptionPlanVersionChangedWebhookEvent::PayloadStyle]
23
+ required :payload_style, enum: -> { Orb::SubscriptionPlanVersionChangedWebhookEvent::PayloadStyle }
24
+
18
25
  # @!attribute properties
19
26
  #
20
27
  # @return [Orb::Models::SubscriptionPlanVersionChangedWebhookEvent::Properties]
@@ -50,7 +57,7 @@ module Orb
50
57
  # @return [Symbol, Orb::Models::SubscriptionPlanVersionChangedWebhookEvent::Type]
51
58
  required :type, enum: -> { Orb::SubscriptionPlanVersionChangedWebhookEvent::Type }
52
59
 
53
- # @!method initialize(id:, created_at:, properties:, subscription:, type:)
60
+ # @!method initialize(id:, created_at:, payload_style:, properties:, subscription:, type:)
54
61
  # Some parameter documentations has been truncated, see
55
62
  # {Orb::Models::SubscriptionPlanVersionChangedWebhookEvent} for more details.
56
63
  #
@@ -60,12 +67,28 @@ module Orb
60
67
  #
61
68
  # @param created_at [Time] The time at which this event was created, to the second.
62
69
  #
70
+ # @param payload_style [Symbol, Orb::Models::SubscriptionPlanVersionChangedWebhookEvent::PayloadStyle] The serialization style this payload was rendered in, as configured on the endpo
71
+ #
63
72
  # @param properties [Orb::Models::SubscriptionPlanVersionChangedWebhookEvent::Properties]
64
73
  #
65
74
  # @param subscription [Orb::Models::Subscription] A [subscription](/core-concepts#subscription) represents the purchase of a plan
66
75
  #
67
76
  # @param type [Symbol, Orb::Models::SubscriptionPlanVersionChangedWebhookEvent::Type] The event this payload describes.
68
77
 
78
+ # The serialization style this payload was rendered in, as configured on the
79
+ # endpoint.
80
+ #
81
+ # @see Orb::Models::SubscriptionPlanVersionChangedWebhookEvent#payload_style
82
+ module PayloadStyle
83
+ extend Orb::Internal::Type::Enum
84
+
85
+ EXPANDED = :expanded
86
+ STANDARD = :standard
87
+
88
+ # @!method self.values
89
+ # @return [Array<Symbol>]
90
+ end
91
+
69
92
  # @see Orb::Models::SubscriptionPlanVersionChangedWebhookEvent#properties
70
93
  class Properties < Orb::Internal::Type::BaseModel
71
94
  # @!attribute effective_date
@@ -15,6 +15,13 @@ module Orb
15
15
  # @return [Time]
16
16
  required :created_at, Time
17
17
 
18
+ # @!attribute payload_style
19
+ # The serialization style this payload was rendered in, as configured on the
20
+ # endpoint.
21
+ #
22
+ # @return [Symbol, Orb::Models::SubscriptionSpendExceededWebhookEvent::PayloadStyle]
23
+ required :payload_style, enum: -> { Orb::SubscriptionSpendExceededWebhookEvent::PayloadStyle }
24
+
18
25
  # @!attribute properties
19
26
  #
20
27
  # @return [Orb::Models::SubscriptionSpendExceededWebhookEvent::Properties]
@@ -50,7 +57,7 @@ module Orb
50
57
  # @return [Symbol, Orb::Models::SubscriptionSpendExceededWebhookEvent::Type]
51
58
  required :type, enum: -> { Orb::SubscriptionSpendExceededWebhookEvent::Type }
52
59
 
53
- # @!method initialize(id:, created_at:, properties:, subscription:, type:)
60
+ # @!method initialize(id:, created_at:, payload_style:, properties:, subscription:, type:)
54
61
  # Some parameter documentations has been truncated, see
55
62
  # {Orb::Models::SubscriptionSpendExceededWebhookEvent} for more details.
56
63
  #
@@ -61,12 +68,28 @@ module Orb
61
68
  #
62
69
  # @param created_at [Time] The time at which this event was created, to the second.
63
70
  #
71
+ # @param payload_style [Symbol, Orb::Models::SubscriptionSpendExceededWebhookEvent::PayloadStyle] The serialization style this payload was rendered in, as configured on the endpo
72
+ #
64
73
  # @param properties [Orb::Models::SubscriptionSpendExceededWebhookEvent::Properties]
65
74
  #
66
75
  # @param subscription [Orb::Models::Subscription] A [subscription](/core-concepts#subscription) represents the purchase of a plan
67
76
  #
68
77
  # @param type [Symbol, Orb::Models::SubscriptionSpendExceededWebhookEvent::Type] The event this payload describes.
69
78
 
79
+ # The serialization style this payload was rendered in, as configured on the
80
+ # endpoint.
81
+ #
82
+ # @see Orb::Models::SubscriptionSpendExceededWebhookEvent#payload_style
83
+ module PayloadStyle
84
+ extend Orb::Internal::Type::Enum
85
+
86
+ EXPANDED = :expanded
87
+ STANDARD = :standard
88
+
89
+ # @!method self.values
90
+ # @return [Array<Symbol>]
91
+ end
92
+
70
93
  # @see Orb::Models::SubscriptionSpendExceededWebhookEvent#properties
71
94
  class Properties < Orb::Internal::Type::BaseModel
72
95
  # @!attribute alert_configuration
@@ -15,6 +15,13 @@ module Orb
15
15
  # @return [Time]
16
16
  required :created_at, Time
17
17
 
18
+ # @!attribute payload_style
19
+ # The serialization style this payload was rendered in, as configured on the
20
+ # endpoint.
21
+ #
22
+ # @return [Symbol, Orb::Models::SubscriptionStartedWebhookEvent::PayloadStyle]
23
+ required :payload_style, enum: -> { Orb::SubscriptionStartedWebhookEvent::PayloadStyle }
24
+
18
25
  # @!attribute properties
19
26
  #
20
27
  # @return [Object]
@@ -50,7 +57,7 @@ module Orb
50
57
  # @return [Symbol, Orb::Models::SubscriptionStartedWebhookEvent::Type]
51
58
  required :type, enum: -> { Orb::SubscriptionStartedWebhookEvent::Type }
52
59
 
53
- # @!method initialize(id:, created_at:, properties:, subscription:, type:)
60
+ # @!method initialize(id:, created_at:, payload_style:, properties:, subscription:, type:)
54
61
  # Some parameter documentations has been truncated, see
55
62
  # {Orb::Models::SubscriptionStartedWebhookEvent} for more details.
56
63
  #
@@ -60,12 +67,28 @@ module Orb
60
67
  #
61
68
  # @param created_at [Time] The time at which this event was created, to the second.
62
69
  #
70
+ # @param payload_style [Symbol, Orb::Models::SubscriptionStartedWebhookEvent::PayloadStyle] The serialization style this payload was rendered in, as configured on the endpo
71
+ #
63
72
  # @param properties [Object]
64
73
  #
65
74
  # @param subscription [Orb::Models::Subscription] A [subscription](/core-concepts#subscription) represents the purchase of a plan
66
75
  #
67
76
  # @param type [Symbol, Orb::Models::SubscriptionStartedWebhookEvent::Type] The event this payload describes.
68
77
 
78
+ # The serialization style this payload was rendered in, as configured on the
79
+ # endpoint.
80
+ #
81
+ # @see Orb::Models::SubscriptionStartedWebhookEvent#payload_style
82
+ module PayloadStyle
83
+ extend Orb::Internal::Type::Enum
84
+
85
+ EXPANDED = :expanded
86
+ STANDARD = :standard
87
+
88
+ # @!method self.values
89
+ # @return [Array<Symbol>]
90
+ end
91
+
69
92
  # The event this payload describes.
70
93
  #
71
94
  # @see Orb::Models::SubscriptionStartedWebhookEvent#type
@@ -15,6 +15,13 @@ module Orb
15
15
  # @return [Time]
16
16
  required :created_at, Time
17
17
 
18
+ # @!attribute payload_style
19
+ # The serialization style this payload was rendered in, as configured on the
20
+ # endpoint.
21
+ #
22
+ # @return [Symbol, Orb::Models::SubscriptionTrialEndedWebhookEvent::PayloadStyle]
23
+ required :payload_style, enum: -> { Orb::SubscriptionTrialEndedWebhookEvent::PayloadStyle }
24
+
18
25
  # @!attribute properties
19
26
  #
20
27
  # @return [Object]
@@ -50,7 +57,7 @@ module Orb
50
57
  # @return [Symbol, Orb::Models::SubscriptionTrialEndedWebhookEvent::Type]
51
58
  required :type, enum: -> { Orb::SubscriptionTrialEndedWebhookEvent::Type }
52
59
 
53
- # @!method initialize(id:, created_at:, properties:, subscription:, type:)
60
+ # @!method initialize(id:, created_at:, payload_style:, properties:, subscription:, type:)
54
61
  # Some parameter documentations has been truncated, see
55
62
  # {Orb::Models::SubscriptionTrialEndedWebhookEvent} for more details.
56
63
  #
@@ -60,12 +67,28 @@ module Orb
60
67
  #
61
68
  # @param created_at [Time] The time at which this event was created, to the second.
62
69
  #
70
+ # @param payload_style [Symbol, Orb::Models::SubscriptionTrialEndedWebhookEvent::PayloadStyle] The serialization style this payload was rendered in, as configured on the endpo
71
+ #
63
72
  # @param properties [Object]
64
73
  #
65
74
  # @param subscription [Orb::Models::Subscription] A [subscription](/core-concepts#subscription) represents the purchase of a plan
66
75
  #
67
76
  # @param type [Symbol, Orb::Models::SubscriptionTrialEndedWebhookEvent::Type] The event this payload describes.
68
77
 
78
+ # The serialization style this payload was rendered in, as configured on the
79
+ # endpoint.
80
+ #
81
+ # @see Orb::Models::SubscriptionTrialEndedWebhookEvent#payload_style
82
+ module PayloadStyle
83
+ extend Orb::Internal::Type::Enum
84
+
85
+ EXPANDED = :expanded
86
+ STANDARD = :standard
87
+
88
+ # @!method self.values
89
+ # @return [Array<Symbol>]
90
+ end
91
+
69
92
  # The event this payload describes.
70
93
  #
71
94
  # @see Orb::Models::SubscriptionTrialEndedWebhookEvent#type
@@ -15,6 +15,13 @@ module Orb
15
15
  # @return [Time]
16
16
  required :created_at, Time
17
17
 
18
+ # @!attribute payload_style
19
+ # The serialization style this payload was rendered in, as configured on the
20
+ # endpoint.
21
+ #
22
+ # @return [Symbol, Orb::Models::SubscriptionUsageExceededWebhookEvent::PayloadStyle]
23
+ required :payload_style, enum: -> { Orb::SubscriptionUsageExceededWebhookEvent::PayloadStyle }
24
+
18
25
  # @!attribute properties
19
26
  #
20
27
  # @return [Orb::Models::SubscriptionUsageExceededWebhookEvent::Properties]
@@ -50,7 +57,7 @@ module Orb
50
57
  # @return [Symbol, Orb::Models::SubscriptionUsageExceededWebhookEvent::Type]
51
58
  required :type, enum: -> { Orb::SubscriptionUsageExceededWebhookEvent::Type }
52
59
 
53
- # @!method initialize(id:, created_at:, properties:, subscription:, type:)
60
+ # @!method initialize(id:, created_at:, payload_style:, properties:, subscription:, type:)
54
61
  # Some parameter documentations has been truncated, see
55
62
  # {Orb::Models::SubscriptionUsageExceededWebhookEvent} for more details.
56
63
  #
@@ -61,12 +68,28 @@ module Orb
61
68
  #
62
69
  # @param created_at [Time] The time at which this event was created, to the second.
63
70
  #
71
+ # @param payload_style [Symbol, Orb::Models::SubscriptionUsageExceededWebhookEvent::PayloadStyle] The serialization style this payload was rendered in, as configured on the endpo
72
+ #
64
73
  # @param properties [Orb::Models::SubscriptionUsageExceededWebhookEvent::Properties]
65
74
  #
66
75
  # @param subscription [Orb::Models::Subscription] A [subscription](/core-concepts#subscription) represents the purchase of a plan
67
76
  #
68
77
  # @param type [Symbol, Orb::Models::SubscriptionUsageExceededWebhookEvent::Type] The event this payload describes.
69
78
 
79
+ # The serialization style this payload was rendered in, as configured on the
80
+ # endpoint.
81
+ #
82
+ # @see Orb::Models::SubscriptionUsageExceededWebhookEvent#payload_style
83
+ module PayloadStyle
84
+ extend Orb::Internal::Type::Enum
85
+
86
+ EXPANDED = :expanded
87
+ STANDARD = :standard
88
+
89
+ # @!method self.values
90
+ # @return [Array<Symbol>]
91
+ end
92
+
70
93
  # @see Orb::Models::SubscriptionUsageExceededWebhookEvent#properties
71
94
  class Properties < Orb::Internal::Type::BaseModel
72
95
  # @!attribute alert_configuration
@@ -21,12 +21,43 @@ module Orb
21
21
  # @return [String, nil]
22
22
  required :tax_rate_percentage, String, nil?: true
23
23
 
24
- # @!method initialize(amount:, tax_rate_description:, tax_rate_percentage:)
24
+ # @!attribute tax_reason
25
+ # Why this tax was or was not charged, such as reverse_charge or customer_exempt.
26
+ # Null on tax calculated before reasons were recorded.
27
+ #
28
+ # @return [Symbol, Orb::Models::TaxAmount::TaxReason, nil]
29
+ optional :tax_reason, enum: -> { Orb::TaxAmount::TaxReason }, nil?: true
30
+
31
+ # @!method initialize(amount:, tax_rate_description:, tax_rate_percentage:, tax_reason: nil)
32
+ # Some parameter documentations has been truncated, see {Orb::Models::TaxAmount}
33
+ # for more details.
34
+ #
25
35
  # @param amount [String] The amount of additional tax incurred by this tax rate.
26
36
  #
27
37
  # @param tax_rate_description [String] The human-readable description of the applied tax rate.
28
38
  #
29
39
  # @param tax_rate_percentage [String, nil] The tax rate percentage, out of 100.
40
+ #
41
+ # @param tax_reason [Symbol, Orb::Models::TaxAmount::TaxReason, nil] Why this tax was or was not charged, such as reverse_charge or customer_exempt.
42
+
43
+ # Why this tax was or was not charged, such as reverse_charge or customer_exempt.
44
+ # Null on tax calculated before reasons were recorded.
45
+ #
46
+ # @see Orb::Models::TaxAmount#tax_reason
47
+ module TaxReason
48
+ extend Orb::Internal::Type::Enum
49
+
50
+ TAXED = :taxed
51
+ REVERSE_CHARGE = :reverse_charge
52
+ CUSTOMER_EXEMPT = :customer_exempt
53
+ PRODUCT_EXEMPT = :product_exempt
54
+ NOT_REGISTERED = :not_registered
55
+ ZERO_RATED = :zero_rated
56
+ NOT_TAXED_OTHER = :not_taxed_other
57
+
58
+ # @!method self.values
59
+ # @return [Array<Symbol>]
60
+ end
30
61
  end
31
62
  end
32
63
  end
@@ -21,6 +21,13 @@ module Orb
21
21
  # @return [Time]
22
22
  required :created_at, Time
23
23
 
24
+ # @!attribute payload_style
25
+ # The serialization style this payload was rendered in, as configured on the
26
+ # endpoint.
27
+ #
28
+ # @return [Symbol, Orb::Models::TransactionAccountingSyncFailedWebhookEvent::PayloadStyle]
29
+ required :payload_style, enum: -> { Orb::TransactionAccountingSyncFailedWebhookEvent::PayloadStyle }
30
+
24
31
  # @!attribute properties
25
32
  #
26
33
  # @return [Orb::Models::TransactionAccountingSyncFailedWebhookEvent::Properties]
@@ -37,7 +44,10 @@ module Orb
37
44
  # @return [Symbol, Orb::Models::TransactionAccountingSyncFailedWebhookEvent::Type]
38
45
  required :type, enum: -> { Orb::TransactionAccountingSyncFailedWebhookEvent::Type }
39
46
 
40
- # @!method initialize(id:, accounting_sync_record:, created_at:, properties:, transaction:, type:)
47
+ # @!method initialize(id:, accounting_sync_record:, created_at:, payload_style:, properties:, transaction:, type:)
48
+ # Some parameter documentations has been truncated, see
49
+ # {Orb::Models::TransactionAccountingSyncFailedWebhookEvent} for more details.
50
+ #
41
51
  # Issued when a transaction accounting sync fails.
42
52
  #
43
53
  # @param id [String] The ID of this webhook event.
@@ -46,6 +56,8 @@ module Orb
46
56
  #
47
57
  # @param created_at [Time] The time at which this event was created, to the second.
48
58
  #
59
+ # @param payload_style [Symbol, Orb::Models::TransactionAccountingSyncFailedWebhookEvent::PayloadStyle] The serialization style this payload was rendered in, as configured on the endpo
60
+ #
49
61
  # @param properties [Orb::Models::TransactionAccountingSyncFailedWebhookEvent::Properties]
50
62
  #
51
63
  # @param transaction [Orb::Models::TransactionAccountingSyncFailedWebhookEvent::Transaction]
@@ -123,6 +135,20 @@ module Orb
123
135
  end
124
136
  end
125
137
 
138
+ # The serialization style this payload was rendered in, as configured on the
139
+ # endpoint.
140
+ #
141
+ # @see Orb::Models::TransactionAccountingSyncFailedWebhookEvent#payload_style
142
+ module PayloadStyle
143
+ extend Orb::Internal::Type::Enum
144
+
145
+ EXPANDED = :expanded
146
+ STANDARD = :standard
147
+
148
+ # @!method self.values
149
+ # @return [Array<Symbol>]
150
+ end
151
+
126
152
  # @see Orb::Models::TransactionAccountingSyncFailedWebhookEvent#properties
127
153
  class Properties < Orb::Internal::Type::BaseModel
128
154
  # @!attribute connection_type
@@ -21,6 +21,13 @@ module Orb
21
21
  # @return [Time]
22
22
  required :created_at, Time
23
23
 
24
+ # @!attribute payload_style
25
+ # The serialization style this payload was rendered in, as configured on the
26
+ # endpoint.
27
+ #
28
+ # @return [Symbol, Orb::Models::TransactionAccountingSyncSucceededWebhookEvent::PayloadStyle]
29
+ required :payload_style, enum: -> { Orb::TransactionAccountingSyncSucceededWebhookEvent::PayloadStyle }
30
+
24
31
  # @!attribute properties
25
32
  #
26
33
  # @return [Orb::Models::TransactionAccountingSyncSucceededWebhookEvent::Properties]
@@ -37,7 +44,10 @@ module Orb
37
44
  # @return [Symbol, Orb::Models::TransactionAccountingSyncSucceededWebhookEvent::Type]
38
45
  required :type, enum: -> { Orb::TransactionAccountingSyncSucceededWebhookEvent::Type }
39
46
 
40
- # @!method initialize(id:, accounting_sync_record:, created_at:, properties:, transaction:, type:)
47
+ # @!method initialize(id:, accounting_sync_record:, created_at:, payload_style:, properties:, transaction:, type:)
48
+ # Some parameter documentations has been truncated, see
49
+ # {Orb::Models::TransactionAccountingSyncSucceededWebhookEvent} for more details.
50
+ #
41
51
  # Issued when a transaction accounting sync succeeds.
42
52
  #
43
53
  # @param id [String] The ID of this webhook event.
@@ -46,6 +56,8 @@ module Orb
46
56
  #
47
57
  # @param created_at [Time] The time at which this event was created, to the second.
48
58
  #
59
+ # @param payload_style [Symbol, Orb::Models::TransactionAccountingSyncSucceededWebhookEvent::PayloadStyle] The serialization style this payload was rendered in, as configured on the endpo
60
+ #
49
61
  # @param properties [Orb::Models::TransactionAccountingSyncSucceededWebhookEvent::Properties]
50
62
  #
51
63
  # @param transaction [Orb::Models::TransactionAccountingSyncSucceededWebhookEvent::Transaction]
@@ -123,6 +135,20 @@ module Orb
123
135
  end
124
136
  end
125
137
 
138
+ # The serialization style this payload was rendered in, as configured on the
139
+ # endpoint.
140
+ #
141
+ # @see Orb::Models::TransactionAccountingSyncSucceededWebhookEvent#payload_style
142
+ module PayloadStyle
143
+ extend Orb::Internal::Type::Enum
144
+
145
+ EXPANDED = :expanded
146
+ STANDARD = :standard
147
+
148
+ # @!method self.values
149
+ # @return [Array<Symbol>]
150
+ end
151
+
126
152
  # @see Orb::Models::TransactionAccountingSyncSucceededWebhookEvent#properties
127
153
  class Properties < Orb::Internal::Type::BaseModel
128
154
  # @!attribute connection_type
@@ -153,9 +153,15 @@ module Orb
153
153
  # Issued when a payment method is deleted.
154
154
  variant -> { Orb::PaymentMethodDeletedWebhookEvent }
155
155
 
156
+ # Issued when a plan is created, or when a draft plan is published.
157
+ variant -> { Orb::PlanCreatedWebhookEvent }
158
+
156
159
  # Issued when a plan's default version is set.
157
160
  variant -> { Orb::PlanDefaultVersionSetWebhookEvent }
158
161
 
162
+ # Issued when a plan's name, description, external plan ID, metadata or status is edited.
163
+ variant -> { Orb::PlanEditedWebhookEvent }
164
+
159
165
  # Issued when a new plan version is created.
160
166
  variant -> { Orb::PlanVersionCreatedWebhookEvent }
161
167
 
@@ -244,7 +250,7 @@ module Orb
244
250
  variant -> { Orb::TransactionAccountingSyncSucceededWebhookEvent }
245
251
 
246
252
  # @!method self.variants
247
- # @return [Array(Orb::Models::BackfillReflectedWebhookEvent, Orb::Models::BackfillRevertedWebhookEvent, Orb::Models::BillableMetricEditedWebhookEvent, Orb::Models::CreditBlockAccountingSyncFailedWebhookEvent, Orb::Models::CreditBlockAccountingSyncSucceededWebhookEvent, Orb::Models::CreditNoteAccountingSyncFailedWebhookEvent, Orb::Models::CreditNoteAccountingSyncSucceededWebhookEvent, Orb::Models::CreditNoteIssuedWebhookEvent, Orb::Models::CreditNoteMarkedAsVoidWebhookEvent, Orb::Models::CustomerAccountingSyncFailedWebhookEvent, Orb::Models::CustomerAccountingSyncSucceededWebhookEvent, Orb::Models::CustomerBalanceTransactionCreatedWebhookEvent, Orb::Models::CustomerCreatedWebhookEvent, Orb::Models::CustomerCreditBalanceDepletedWebhookEvent, Orb::Models::CustomerCreditBalanceDroppedWebhookEvent, Orb::Models::CustomerCreditBalanceRecoveredWebhookEvent, Orb::Models::CustomerCreditLedgerIncrementedWebhookEvent, Orb::Models::CustomerEditedWebhookEvent, Orb::Models::DataExportsTransferErrorWebhookEvent, Orb::Models::DataExportsTransferSuccessWebhookEvent, Orb::Models::EventUnmatchedEventWebhookEvent, Orb::Models::IngestionUnmatchedCustomerIDsWebhookEvent, Orb::Models::InvoiceAccountingSyncFailedWebhookEvent, Orb::Models::InvoiceAccountingSyncSucceededWebhookEvent, Orb::Models::InvoiceAutomationScheduleStepExecutedWebhookEvent, Orb::Models::InvoiceCostDataExportedWebhookEvent, Orb::Models::InvoiceDunningScheduleCreatedWebhookEvent, Orb::Models::InvoiceDunningScheduleEndedWebhookEvent, Orb::Models::InvoiceDunningScheduleResetWebhookEvent, Orb::Models::InvoiceDunningScheduleStepExecutedWebhookEvent, Orb::Models::InvoiceEditedWebhookEvent, Orb::Models::InvoiceInvoiceDateElapsedWebhookEvent, Orb::Models::InvoiceIssueFailedWebhookEvent, Orb::Models::InvoiceIssuedWebhookEvent, Orb::Models::InvoiceIssuedSummaryWebhookEvent, Orb::Models::InvoiceManuallyMarkedAsPaidWebhookEvent, Orb::Models::InvoiceManuallyMarkedAsVoidWebhookEvent, Orb::Models::InvoicePaymentFailedWebhookEvent, Orb::Models::InvoicePaymentProcessingWebhookEvent, Orb::Models::InvoicePaymentSucceededWebhookEvent, Orb::Models::InvoiceSyncFailedWebhookEvent, Orb::Models::InvoiceSyncSucceededWebhookEvent, Orb::Models::InvoiceUndoMarkAsPaidWebhookEvent, Orb::Models::InvoiceDueDateRecalculationCanceledWebhookEvent, Orb::Models::InvoiceDueDateRecalculationCompletedWebhookEvent, Orb::Models::InvoiceDueDateRecalculationStartedWebhookEvent, Orb::Models::MetricEventsDroppedByWatermarkWebhookEvent, Orb::Models::PaymentMethodCreatedWebhookEvent, Orb::Models::PaymentMethodDeletedWebhookEvent, Orb::Models::PlanDefaultVersionSetWebhookEvent, Orb::Models::PlanVersionCreatedWebhookEvent, Orb::Models::PriceEditedWebhookEvent, Orb::Models::ResourceEventTestWebhookEvent, Orb::Models::SalesOrderAccountingSyncFailedWebhookEvent, Orb::Models::SalesOrderAccountingSyncSucceededWebhookEvent, Orb::Models::SubscriptionAccountingSyncFailedWebhookEvent, Orb::Models::SubscriptionAccountingSyncSucceededWebhookEvent, Orb::Models::SubscriptionAlertDisabledWebhookEvent, Orb::Models::SubscriptionCancellationScheduledWebhookEvent, Orb::Models::SubscriptionCancellationUnscheduledWebhookEvent, Orb::Models::SubscriptionCostExceededWebhookEvent, Orb::Models::SubscriptionCreatedWebhookEvent, Orb::Models::SubscriptionEditedWebhookEvent, Orb::Models::SubscriptionEndedWebhookEvent, Orb::Models::SubscriptionFixedFeeQuantityUpdatedWebhookEvent, Orb::Models::SubscriptionGroupedCostExceededWebhookEvent, Orb::Models::SubscriptionInvoicingThresholdExceededWebhookEvent, Orb::Models::SubscriptionLicenseAllocationResetWebhookEvent, Orb::Models::SubscriptionLicenseBalanceThresholdReachedWebhookEvent, Orb::Models::SubscriptionPlanChangeScheduledWebhookEvent, Orb::Models::SubscriptionPlanChangedWebhookEvent, Orb::Models::SubscriptionPlanVersionChangeScheduledWebhookEvent, Orb::Models::SubscriptionPlanVersionChangedWebhookEvent, Orb::Models::SubscriptionSpendExceededWebhookEvent, Orb::Models::SubscriptionStartedWebhookEvent, Orb::Models::SubscriptionTrialEndedWebhookEvent, Orb::Models::SubscriptionUsageExceededWebhookEvent, Orb::Models::TransactionAccountingSyncFailedWebhookEvent, Orb::Models::TransactionAccountingSyncSucceededWebhookEvent)]
253
+ # @return [Array(Orb::Models::BackfillReflectedWebhookEvent, Orb::Models::BackfillRevertedWebhookEvent, Orb::Models::BillableMetricEditedWebhookEvent, Orb::Models::CreditBlockAccountingSyncFailedWebhookEvent, Orb::Models::CreditBlockAccountingSyncSucceededWebhookEvent, Orb::Models::CreditNoteAccountingSyncFailedWebhookEvent, Orb::Models::CreditNoteAccountingSyncSucceededWebhookEvent, Orb::Models::CreditNoteIssuedWebhookEvent, Orb::Models::CreditNoteMarkedAsVoidWebhookEvent, Orb::Models::CustomerAccountingSyncFailedWebhookEvent, Orb::Models::CustomerAccountingSyncSucceededWebhookEvent, Orb::Models::CustomerBalanceTransactionCreatedWebhookEvent, Orb::Models::CustomerCreatedWebhookEvent, Orb::Models::CustomerCreditBalanceDepletedWebhookEvent, Orb::Models::CustomerCreditBalanceDroppedWebhookEvent, Orb::Models::CustomerCreditBalanceRecoveredWebhookEvent, Orb::Models::CustomerCreditLedgerIncrementedWebhookEvent, Orb::Models::CustomerEditedWebhookEvent, Orb::Models::DataExportsTransferErrorWebhookEvent, Orb::Models::DataExportsTransferSuccessWebhookEvent, Orb::Models::EventUnmatchedEventWebhookEvent, Orb::Models::IngestionUnmatchedCustomerIDsWebhookEvent, Orb::Models::InvoiceAccountingSyncFailedWebhookEvent, Orb::Models::InvoiceAccountingSyncSucceededWebhookEvent, Orb::Models::InvoiceAutomationScheduleStepExecutedWebhookEvent, Orb::Models::InvoiceCostDataExportedWebhookEvent, Orb::Models::InvoiceDunningScheduleCreatedWebhookEvent, Orb::Models::InvoiceDunningScheduleEndedWebhookEvent, Orb::Models::InvoiceDunningScheduleResetWebhookEvent, Orb::Models::InvoiceDunningScheduleStepExecutedWebhookEvent, Orb::Models::InvoiceEditedWebhookEvent, Orb::Models::InvoiceInvoiceDateElapsedWebhookEvent, Orb::Models::InvoiceIssueFailedWebhookEvent, Orb::Models::InvoiceIssuedWebhookEvent, Orb::Models::InvoiceIssuedSummaryWebhookEvent, Orb::Models::InvoiceManuallyMarkedAsPaidWebhookEvent, Orb::Models::InvoiceManuallyMarkedAsVoidWebhookEvent, Orb::Models::InvoicePaymentFailedWebhookEvent, Orb::Models::InvoicePaymentProcessingWebhookEvent, Orb::Models::InvoicePaymentSucceededWebhookEvent, Orb::Models::InvoiceSyncFailedWebhookEvent, Orb::Models::InvoiceSyncSucceededWebhookEvent, Orb::Models::InvoiceUndoMarkAsPaidWebhookEvent, Orb::Models::InvoiceDueDateRecalculationCanceledWebhookEvent, Orb::Models::InvoiceDueDateRecalculationCompletedWebhookEvent, Orb::Models::InvoiceDueDateRecalculationStartedWebhookEvent, Orb::Models::MetricEventsDroppedByWatermarkWebhookEvent, Orb::Models::PaymentMethodCreatedWebhookEvent, Orb::Models::PaymentMethodDeletedWebhookEvent, Orb::Models::PlanCreatedWebhookEvent, Orb::Models::PlanDefaultVersionSetWebhookEvent, Orb::Models::PlanEditedWebhookEvent, Orb::Models::PlanVersionCreatedWebhookEvent, Orb::Models::PriceEditedWebhookEvent, Orb::Models::ResourceEventTestWebhookEvent, Orb::Models::SalesOrderAccountingSyncFailedWebhookEvent, Orb::Models::SalesOrderAccountingSyncSucceededWebhookEvent, Orb::Models::SubscriptionAccountingSyncFailedWebhookEvent, Orb::Models::SubscriptionAccountingSyncSucceededWebhookEvent, Orb::Models::SubscriptionAlertDisabledWebhookEvent, Orb::Models::SubscriptionCancellationScheduledWebhookEvent, Orb::Models::SubscriptionCancellationUnscheduledWebhookEvent, Orb::Models::SubscriptionCostExceededWebhookEvent, Orb::Models::SubscriptionCreatedWebhookEvent, Orb::Models::SubscriptionEditedWebhookEvent, Orb::Models::SubscriptionEndedWebhookEvent, Orb::Models::SubscriptionFixedFeeQuantityUpdatedWebhookEvent, Orb::Models::SubscriptionGroupedCostExceededWebhookEvent, Orb::Models::SubscriptionInvoicingThresholdExceededWebhookEvent, Orb::Models::SubscriptionLicenseAllocationResetWebhookEvent, Orb::Models::SubscriptionLicenseBalanceThresholdReachedWebhookEvent, Orb::Models::SubscriptionPlanChangeScheduledWebhookEvent, Orb::Models::SubscriptionPlanChangedWebhookEvent, Orb::Models::SubscriptionPlanVersionChangeScheduledWebhookEvent, Orb::Models::SubscriptionPlanVersionChangedWebhookEvent, Orb::Models::SubscriptionSpendExceededWebhookEvent, Orb::Models::SubscriptionStartedWebhookEvent, Orb::Models::SubscriptionTrialEndedWebhookEvent, Orb::Models::SubscriptionUsageExceededWebhookEvent, Orb::Models::TransactionAccountingSyncFailedWebhookEvent, Orb::Models::TransactionAccountingSyncSucceededWebhookEvent)]
248
254
  end
249
255
  end
250
256
  end
@@ -0,0 +1,56 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Orb
4
+ module Models
5
+ # @see Orb::Resources::WebhookEndpoints#retrieve
6
+ class WebhookEndpoint < Orb::Internal::Type::BaseModel
7
+ # @!attribute id
8
+ # The Orb-assigned unique identifier for the webhook endpoint.
9
+ #
10
+ # @return [String]
11
+ required :id, String
12
+
13
+ # @!attribute created_at
14
+ # The time the webhook endpoint was created.
15
+ #
16
+ # @return [Time]
17
+ required :created_at, Time
18
+
19
+ # @!attribute enabled
20
+ # Whether Orb sends webhook events to this endpoint.
21
+ #
22
+ # @return [Boolean]
23
+ required :enabled, Orb::Internal::Type::Boolean
24
+
25
+ # @!attribute enabled_event_types
26
+ # The webhook event types sent to this endpoint. If null, all event types are
27
+ # sent.
28
+ #
29
+ # @return [Array<String>, nil]
30
+ required :enabled_event_types, Orb::Internal::Type::ArrayOf[String], nil?: true
31
+
32
+ # @!attribute url
33
+ # The HTTPS URL that Orb sends webhook events to.
34
+ #
35
+ # @return [String]
36
+ required :url, String
37
+
38
+ # @!method initialize(id:, created_at:, enabled:, enabled_event_types:, url:)
39
+ # Some parameter documentations has been truncated, see
40
+ # {Orb::Models::WebhookEndpoint} for more details.
41
+ #
42
+ # A webhook endpoint is an HTTPS URL that Orb sends
43
+ # [webhook events](/integrations-and-exports/webhooks) to.
44
+ #
45
+ # @param id [String] The Orb-assigned unique identifier for the webhook endpoint.
46
+ #
47
+ # @param created_at [Time] The time the webhook endpoint was created.
48
+ #
49
+ # @param enabled [Boolean] Whether Orb sends webhook events to this endpoint.
50
+ #
51
+ # @param enabled_event_types [Array<String>, nil] The webhook event types sent to this endpoint. If null, all event types are sent
52
+ #
53
+ # @param url [String] The HTTPS URL that Orb sends webhook events to.
54
+ end
55
+ end
56
+ end
@@ -0,0 +1,34 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Orb
4
+ module Models
5
+ # @see Orb::Resources::WebhookEndpoints#create
6
+ class WebhookEndpointCreateParams < Orb::Internal::Type::BaseModel
7
+ extend Orb::Internal::Type::RequestParameters::Converter
8
+ include Orb::Internal::Type::RequestParameters
9
+
10
+ # @!attribute url
11
+ # The HTTPS URL that Orb sends webhook events to.
12
+ #
13
+ # @return [String]
14
+ required :url, String
15
+
16
+ # @!attribute enabled_event_types
17
+ # The webhook event types to send to this endpoint. If omitted or null, all event
18
+ # types are sent.
19
+ #
20
+ # @return [Array<String>, nil]
21
+ optional :enabled_event_types, Orb::Internal::Type::ArrayOf[String], nil?: true
22
+
23
+ # @!method initialize(url:, enabled_event_types: nil, request_options: {})
24
+ # Some parameter documentations has been truncated, see
25
+ # {Orb::Models::WebhookEndpointCreateParams} for more details.
26
+ #
27
+ # @param url [String] The HTTPS URL that Orb sends webhook events to.
28
+ #
29
+ # @param enabled_event_types [Array<String>, nil] The webhook event types to send to this endpoint. If omitted or null, all event
30
+ #
31
+ # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
32
+ end
33
+ end
34
+ end
@@ -0,0 +1,20 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Orb
4
+ module Models
5
+ # @see Orb::Resources::WebhookEndpoints#delete
6
+ class WebhookEndpointDeleteParams < Orb::Internal::Type::BaseModel
7
+ extend Orb::Internal::Type::RequestParameters::Converter
8
+ include Orb::Internal::Type::RequestParameters
9
+
10
+ # @!attribute webhook_endpoint_id
11
+ #
12
+ # @return [String]
13
+ required :webhook_endpoint_id, String
14
+
15
+ # @!method initialize(webhook_endpoint_id:, request_options: {})
16
+ # @param webhook_endpoint_id [String]
17
+ # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
18
+ end
19
+ end
20
+ end
@@ -0,0 +1,20 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Orb
4
+ module Models
5
+ # @see Orb::Resources::WebhookEndpoints#disable
6
+ class WebhookEndpointDisableParams < Orb::Internal::Type::BaseModel
7
+ extend Orb::Internal::Type::RequestParameters::Converter
8
+ include Orb::Internal::Type::RequestParameters
9
+
10
+ # @!attribute webhook_endpoint_id
11
+ #
12
+ # @return [String]
13
+ required :webhook_endpoint_id, String
14
+
15
+ # @!method initialize(webhook_endpoint_id:, request_options: {})
16
+ # @param webhook_endpoint_id [String]
17
+ # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
18
+ end
19
+ end
20
+ end
@@ -0,0 +1,20 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Orb
4
+ module Models
5
+ # @see Orb::Resources::WebhookEndpoints#enable
6
+ class WebhookEndpointEnableParams < Orb::Internal::Type::BaseModel
7
+ extend Orb::Internal::Type::RequestParameters::Converter
8
+ include Orb::Internal::Type::RequestParameters
9
+
10
+ # @!attribute webhook_endpoint_id
11
+ #
12
+ # @return [String]
13
+ required :webhook_endpoint_id, String
14
+
15
+ # @!method initialize(webhook_endpoint_id:, request_options: {})
16
+ # @param webhook_endpoint_id [String]
17
+ # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
18
+ end
19
+ end
20
+ end
@@ -0,0 +1,34 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Orb
4
+ module Models
5
+ # @see Orb::Resources::WebhookEndpoints#list
6
+ class WebhookEndpointListParams < Orb::Internal::Type::BaseModel
7
+ extend Orb::Internal::Type::RequestParameters::Converter
8
+ include Orb::Internal::Type::RequestParameters
9
+
10
+ # @!attribute cursor
11
+ # Cursor for pagination. This can be populated by the `next_cursor` value returned
12
+ # from the initial request.
13
+ #
14
+ # @return [String, nil]
15
+ optional :cursor, String, nil?: true
16
+
17
+ # @!attribute limit
18
+ # The number of items to fetch. Defaults to 20.
19
+ #
20
+ # @return [Integer, nil]
21
+ optional :limit, Integer
22
+
23
+ # @!method initialize(cursor: nil, limit: nil, request_options: {})
24
+ # Some parameter documentations has been truncated, see
25
+ # {Orb::Models::WebhookEndpointListParams} for more details.
26
+ #
27
+ # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
28
+ #
29
+ # @param limit [Integer] The number of items to fetch. Defaults to 20.
30
+ #
31
+ # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
32
+ end
33
+ end
34
+ end
@@ -0,0 +1,20 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Orb
4
+ module Models
5
+ # @see Orb::Resources::WebhookEndpoints#retrieve
6
+ class WebhookEndpointRetrieveParams < Orb::Internal::Type::BaseModel
7
+ extend Orb::Internal::Type::RequestParameters::Converter
8
+ include Orb::Internal::Type::RequestParameters
9
+
10
+ # @!attribute webhook_endpoint_id
11
+ #
12
+ # @return [String]
13
+ required :webhook_endpoint_id, String
14
+
15
+ # @!method initialize(webhook_endpoint_id:, request_options: {})
16
+ # @param webhook_endpoint_id [String]
17
+ # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
18
+ end
19
+ end
20
+ end