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
@@ -25,6 +25,13 @@ module Orb
25
25
  # @return [Orb::Models::Invoice]
26
26
  required :invoice, -> { Orb::Invoice }
27
27
 
28
+ # @!attribute payload_style
29
+ # The serialization style this payload was rendered in, as configured on the
30
+ # endpoint.
31
+ #
32
+ # @return [Symbol, Orb::Models::InvoicePaymentProcessingWebhookEvent::PayloadStyle]
33
+ required :payload_style, enum: -> { Orb::InvoicePaymentProcessingWebhookEvent::PayloadStyle }
34
+
28
35
  # @!attribute properties
29
36
  #
30
37
  # @return [Orb::Models::InvoicePaymentProcessingWebhookEvent::Properties]
@@ -36,7 +43,7 @@ module Orb
36
43
  # @return [Symbol, Orb::Models::InvoicePaymentProcessingWebhookEvent::Type]
37
44
  required :type, enum: -> { Orb::InvoicePaymentProcessingWebhookEvent::Type }
38
45
 
39
- # @!method initialize(id:, created_at:, invoice:, properties:, type:)
46
+ # @!method initialize(id:, created_at:, invoice:, payload_style:, properties:, type:)
40
47
  # Some parameter documentations has been truncated, see
41
48
  # {Orb::Models::InvoicePaymentProcessingWebhookEvent} for more details.
42
49
  #
@@ -48,10 +55,26 @@ module Orb
48
55
  #
49
56
  # @param invoice [Orb::Models::Invoice] An [`Invoice`](/core-concepts#invoice) is a fundamental billing entity, represen
50
57
  #
58
+ # @param payload_style [Symbol, Orb::Models::InvoicePaymentProcessingWebhookEvent::PayloadStyle] The serialization style this payload was rendered in, as configured on the endpo
59
+ #
51
60
  # @param properties [Orb::Models::InvoicePaymentProcessingWebhookEvent::Properties]
52
61
  #
53
62
  # @param type [Symbol, Orb::Models::InvoicePaymentProcessingWebhookEvent::Type] The event this payload describes.
54
63
 
64
+ # The serialization style this payload was rendered in, as configured on the
65
+ # endpoint.
66
+ #
67
+ # @see Orb::Models::InvoicePaymentProcessingWebhookEvent#payload_style
68
+ module PayloadStyle
69
+ extend Orb::Internal::Type::Enum
70
+
71
+ EXPANDED = :expanded
72
+ STANDARD = :standard
73
+
74
+ # @!method self.values
75
+ # @return [Array<Symbol>]
76
+ end
77
+
55
78
  # @see Orb::Models::InvoicePaymentProcessingWebhookEvent#properties
56
79
  class Properties < Orb::Internal::Type::BaseModel
57
80
  # @!attribute payment_provider_id
@@ -25,6 +25,13 @@ module Orb
25
25
  # @return [Orb::Models::Invoice]
26
26
  required :invoice, -> { Orb::Invoice }
27
27
 
28
+ # @!attribute payload_style
29
+ # The serialization style this payload was rendered in, as configured on the
30
+ # endpoint.
31
+ #
32
+ # @return [Symbol, Orb::Models::InvoicePaymentSucceededWebhookEvent::PayloadStyle]
33
+ required :payload_style, enum: -> { Orb::InvoicePaymentSucceededWebhookEvent::PayloadStyle }
34
+
28
35
  # @!attribute properties
29
36
  # `shared_payment_token_id` is only on the wire when the payment used one.
30
37
  #
@@ -37,7 +44,7 @@ module Orb
37
44
  # @return [Symbol, Orb::Models::InvoicePaymentSucceededWebhookEvent::Type]
38
45
  required :type, enum: -> { Orb::InvoicePaymentSucceededWebhookEvent::Type }
39
46
 
40
- # @!method initialize(id:, created_at:, invoice:, properties:, type:)
47
+ # @!method initialize(id:, created_at:, invoice:, payload_style:, properties:, type:)
41
48
  # Some parameter documentations has been truncated, see
42
49
  # {Orb::Models::InvoicePaymentSucceededWebhookEvent} for more details.
43
50
  #
@@ -50,10 +57,26 @@ module Orb
50
57
  #
51
58
  # @param invoice [Orb::Models::Invoice] An [`Invoice`](/core-concepts#invoice) is a fundamental billing entity, represen
52
59
  #
60
+ # @param payload_style [Symbol, Orb::Models::InvoicePaymentSucceededWebhookEvent::PayloadStyle] The serialization style this payload was rendered in, as configured on the endpo
61
+ #
53
62
  # @param properties [Orb::Models::InvoicePaymentSucceededWebhookEvent::Properties] `shared_payment_token_id` is only on the wire when the payment used one.
54
63
  #
55
64
  # @param type [Symbol, Orb::Models::InvoicePaymentSucceededWebhookEvent::Type] The event this payload describes.
56
65
 
66
+ # The serialization style this payload was rendered in, as configured on the
67
+ # endpoint.
68
+ #
69
+ # @see Orb::Models::InvoicePaymentSucceededWebhookEvent#payload_style
70
+ module PayloadStyle
71
+ extend Orb::Internal::Type::Enum
72
+
73
+ EXPANDED = :expanded
74
+ STANDARD = :standard
75
+
76
+ # @!method self.values
77
+ # @return [Array<Symbol>]
78
+ end
79
+
57
80
  # @see Orb::Models::InvoicePaymentSucceededWebhookEvent#properties
58
81
  class Properties < Orb::Internal::Type::BaseModel
59
82
  # @!attribute payment_provider
@@ -25,6 +25,13 @@ module Orb
25
25
  # @return [Orb::Models::Invoice]
26
26
  required :invoice, -> { Orb::Invoice }
27
27
 
28
+ # @!attribute payload_style
29
+ # The serialization style this payload was rendered in, as configured on the
30
+ # endpoint.
31
+ #
32
+ # @return [Symbol, Orb::Models::InvoiceSyncFailedWebhookEvent::PayloadStyle]
33
+ required :payload_style, enum: -> { Orb::InvoiceSyncFailedWebhookEvent::PayloadStyle }
34
+
28
35
  # @!attribute properties
29
36
  #
30
37
  # @return [Orb::Models::InvoiceSyncFailedWebhookEvent::Properties]
@@ -36,7 +43,7 @@ module Orb
36
43
  # @return [Symbol, Orb::Models::InvoiceSyncFailedWebhookEvent::Type]
37
44
  required :type, enum: -> { Orb::InvoiceSyncFailedWebhookEvent::Type }
38
45
 
39
- # @!method initialize(id:, created_at:, invoice:, properties:, type:)
46
+ # @!method initialize(id:, created_at:, invoice:, payload_style:, properties:, type:)
40
47
  # Some parameter documentations has been truncated, see
41
48
  # {Orb::Models::InvoiceSyncFailedWebhookEvent} for more details.
42
49
  #
@@ -48,10 +55,26 @@ module Orb
48
55
  #
49
56
  # @param invoice [Orb::Models::Invoice] An [`Invoice`](/core-concepts#invoice) is a fundamental billing entity, represen
50
57
  #
58
+ # @param payload_style [Symbol, Orb::Models::InvoiceSyncFailedWebhookEvent::PayloadStyle] The serialization style this payload was rendered in, as configured on the endpo
59
+ #
51
60
  # @param properties [Orb::Models::InvoiceSyncFailedWebhookEvent::Properties]
52
61
  #
53
62
  # @param type [Symbol, Orb::Models::InvoiceSyncFailedWebhookEvent::Type] The event this payload describes.
54
63
 
64
+ # The serialization style this payload was rendered in, as configured on the
65
+ # endpoint.
66
+ #
67
+ # @see Orb::Models::InvoiceSyncFailedWebhookEvent#payload_style
68
+ module PayloadStyle
69
+ extend Orb::Internal::Type::Enum
70
+
71
+ EXPANDED = :expanded
72
+ STANDARD = :standard
73
+
74
+ # @!method self.values
75
+ # @return [Array<Symbol>]
76
+ end
77
+
55
78
  # @see Orb::Models::InvoiceSyncFailedWebhookEvent#properties
56
79
  class Properties < Orb::Internal::Type::BaseModel
57
80
  # @!attribute payment_provider
@@ -25,6 +25,13 @@ module Orb
25
25
  # @return [Orb::Models::Invoice]
26
26
  required :invoice, -> { Orb::Invoice }
27
27
 
28
+ # @!attribute payload_style
29
+ # The serialization style this payload was rendered in, as configured on the
30
+ # endpoint.
31
+ #
32
+ # @return [Symbol, Orb::Models::InvoiceSyncSucceededWebhookEvent::PayloadStyle]
33
+ required :payload_style, enum: -> { Orb::InvoiceSyncSucceededWebhookEvent::PayloadStyle }
34
+
28
35
  # @!attribute properties
29
36
  #
30
37
  # @return [Orb::Models::InvoiceSyncSucceededWebhookEvent::Properties]
@@ -36,7 +43,7 @@ module Orb
36
43
  # @return [Symbol, Orb::Models::InvoiceSyncSucceededWebhookEvent::Type]
37
44
  required :type, enum: -> { Orb::InvoiceSyncSucceededWebhookEvent::Type }
38
45
 
39
- # @!method initialize(id:, created_at:, invoice:, properties:, type:)
46
+ # @!method initialize(id:, created_at:, invoice:, payload_style:, properties:, type:)
40
47
  # Some parameter documentations has been truncated, see
41
48
  # {Orb::Models::InvoiceSyncSucceededWebhookEvent} for more details.
42
49
  #
@@ -48,10 +55,26 @@ module Orb
48
55
  #
49
56
  # @param invoice [Orb::Models::Invoice] An [`Invoice`](/core-concepts#invoice) is a fundamental billing entity, represen
50
57
  #
58
+ # @param payload_style [Symbol, Orb::Models::InvoiceSyncSucceededWebhookEvent::PayloadStyle] The serialization style this payload was rendered in, as configured on the endpo
59
+ #
51
60
  # @param properties [Orb::Models::InvoiceSyncSucceededWebhookEvent::Properties]
52
61
  #
53
62
  # @param type [Symbol, Orb::Models::InvoiceSyncSucceededWebhookEvent::Type] The event this payload describes.
54
63
 
64
+ # The serialization style this payload was rendered in, as configured on the
65
+ # endpoint.
66
+ #
67
+ # @see Orb::Models::InvoiceSyncSucceededWebhookEvent#payload_style
68
+ module PayloadStyle
69
+ extend Orb::Internal::Type::Enum
70
+
71
+ EXPANDED = :expanded
72
+ STANDARD = :standard
73
+
74
+ # @!method self.values
75
+ # @return [Array<Symbol>]
76
+ end
77
+
55
78
  # @see Orb::Models::InvoiceSyncSucceededWebhookEvent#properties
56
79
  class Properties < Orb::Internal::Type::BaseModel
57
80
  # @!attribute payment_provider
@@ -25,6 +25,13 @@ module Orb
25
25
  # @return [Orb::Models::Invoice]
26
26
  required :invoice, -> { Orb::Invoice }
27
27
 
28
+ # @!attribute payload_style
29
+ # The serialization style this payload was rendered in, as configured on the
30
+ # endpoint.
31
+ #
32
+ # @return [Symbol, Orb::Models::InvoiceUndoMarkAsPaidWebhookEvent::PayloadStyle]
33
+ required :payload_style, enum: -> { Orb::InvoiceUndoMarkAsPaidWebhookEvent::PayloadStyle }
34
+
28
35
  # @!attribute properties
29
36
  #
30
37
  # @return [Object]
@@ -36,7 +43,7 @@ module Orb
36
43
  # @return [Symbol, Orb::Models::InvoiceUndoMarkAsPaidWebhookEvent::Type]
37
44
  required :type, enum: -> { Orb::InvoiceUndoMarkAsPaidWebhookEvent::Type }
38
45
 
39
- # @!method initialize(id:, created_at:, invoice:, properties:, type:)
46
+ # @!method initialize(id:, created_at:, invoice:, payload_style:, properties:, type:)
40
47
  # Some parameter documentations has been truncated, see
41
48
  # {Orb::Models::InvoiceUndoMarkAsPaidWebhookEvent} for more details.
42
49
  #
@@ -48,10 +55,26 @@ module Orb
48
55
  #
49
56
  # @param invoice [Orb::Models::Invoice] An [`Invoice`](/core-concepts#invoice) is a fundamental billing entity, represen
50
57
  #
58
+ # @param payload_style [Symbol, Orb::Models::InvoiceUndoMarkAsPaidWebhookEvent::PayloadStyle] The serialization style this payload was rendered in, as configured on the endpo
59
+ #
51
60
  # @param properties [Object]
52
61
  #
53
62
  # @param type [Symbol, Orb::Models::InvoiceUndoMarkAsPaidWebhookEvent::Type] The event this payload describes.
54
63
 
64
+ # The serialization style this payload was rendered in, as configured on the
65
+ # endpoint.
66
+ #
67
+ # @see Orb::Models::InvoiceUndoMarkAsPaidWebhookEvent#payload_style
68
+ module PayloadStyle
69
+ extend Orb::Internal::Type::Enum
70
+
71
+ EXPANDED = :expanded
72
+ STANDARD = :standard
73
+
74
+ # @!method self.values
75
+ # @return [Array<Symbol>]
76
+ end
77
+
55
78
  # The event this payload describes.
56
79
  #
57
80
  # @see Orb::Models::InvoiceUndoMarkAsPaidWebhookEvent#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::MetricEventsDroppedByWatermarkWebhookEvent::PayloadStyle]
23
+ required :payload_style, enum: -> { Orb::MetricEventsDroppedByWatermarkWebhookEvent::PayloadStyle }
24
+
18
25
  # @!attribute properties
19
26
  # `window_start` and `window_end` are ISO-8601 strings rather than datetimes: the
20
27
  # untyped message called `.isoformat()` on them, so they keep microseconds where
@@ -29,7 +36,7 @@ module Orb
29
36
  # @return [Symbol, Orb::Models::MetricEventsDroppedByWatermarkWebhookEvent::Type]
30
37
  required :type, enum: -> { Orb::MetricEventsDroppedByWatermarkWebhookEvent::Type }
31
38
 
32
- # @!method initialize(id:, created_at:, properties:, type:)
39
+ # @!method initialize(id:, created_at:, payload_style:, properties:, type:)
33
40
  # Some parameter documentations has been truncated, see
34
41
  # {Orb::Models::MetricEventsDroppedByWatermarkWebhookEvent} for more details.
35
42
  #
@@ -39,10 +46,26 @@ module Orb
39
46
  #
40
47
  # @param created_at [Time] The time at which this event was created, to the second.
41
48
  #
49
+ # @param payload_style [Symbol, Orb::Models::MetricEventsDroppedByWatermarkWebhookEvent::PayloadStyle] The serialization style this payload was rendered in, as configured on the endpo
50
+ #
42
51
  # @param properties [Orb::Models::MetricEventsDroppedByWatermarkWebhookEvent::Properties] `window_start` and `window_end` are ISO-8601 strings rather than datetimes: the
43
52
  #
44
53
  # @param type [Symbol, Orb::Models::MetricEventsDroppedByWatermarkWebhookEvent::Type] The event this payload describes.
45
54
 
55
+ # The serialization style this payload was rendered in, as configured on the
56
+ # endpoint.
57
+ #
58
+ # @see Orb::Models::MetricEventsDroppedByWatermarkWebhookEvent#payload_style
59
+ module PayloadStyle
60
+ extend Orb::Internal::Type::Enum
61
+
62
+ EXPANDED = :expanded
63
+ STANDARD = :standard
64
+
65
+ # @!method self.values
66
+ # @return [Array<Symbol>]
67
+ end
68
+
46
69
  # @see Orb::Models::MetricEventsDroppedByWatermarkWebhookEvent#properties
47
70
  class Properties < Orb::Internal::Type::BaseModel
48
71
  # @!attribute dropped
@@ -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::PaymentMethodCreatedWebhookEvent::PayloadStyle]
23
+ required :payload_style, enum: -> { Orb::PaymentMethodCreatedWebhookEvent::PayloadStyle }
24
+
18
25
  # @!attribute payment_method
19
26
  # A payment method represents a customer's stored payment instrument held with an
20
27
  # external payment provider (such as Adyen or Stripe).
@@ -36,7 +43,7 @@ module Orb
36
43
  # @return [Symbol, Orb::Models::PaymentMethodCreatedWebhookEvent::Type]
37
44
  required :type, enum: -> { Orb::PaymentMethodCreatedWebhookEvent::Type }
38
45
 
39
- # @!method initialize(id:, created_at:, payment_method:, properties:, type:)
46
+ # @!method initialize(id:, created_at:, payload_style:, payment_method:, properties:, type:)
40
47
  # Some parameter documentations has been truncated, see
41
48
  # {Orb::Models::PaymentMethodCreatedWebhookEvent} for more details.
42
49
  #
@@ -46,12 +53,28 @@ module Orb
46
53
  #
47
54
  # @param created_at [Time] The time at which this event was created, to the second.
48
55
  #
56
+ # @param payload_style [Symbol, Orb::Models::PaymentMethodCreatedWebhookEvent::PayloadStyle] The serialization style this payload was rendered in, as configured on the endpo
57
+ #
49
58
  # @param payment_method [Orb::Models::PaymentMethodCreatedWebhookEvent::PaymentMethod] A payment method represents a customer's stored payment instrument held with an
50
59
  #
51
60
  # @param properties [Object]
52
61
  #
53
62
  # @param type [Symbol, Orb::Models::PaymentMethodCreatedWebhookEvent::Type] The event this payload describes.
54
63
 
64
+ # The serialization style this payload was rendered in, as configured on the
65
+ # endpoint.
66
+ #
67
+ # @see Orb::Models::PaymentMethodCreatedWebhookEvent#payload_style
68
+ module PayloadStyle
69
+ extend Orb::Internal::Type::Enum
70
+
71
+ EXPANDED = :expanded
72
+ STANDARD = :standard
73
+
74
+ # @!method self.values
75
+ # @return [Array<Symbol>]
76
+ end
77
+
55
78
  # @see Orb::Models::PaymentMethodCreatedWebhookEvent#payment_method
56
79
  class PaymentMethod < Orb::Internal::Type::BaseModel
57
80
  # @!attribute id
@@ -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::PaymentMethodDeletedWebhookEvent::PayloadStyle]
23
+ required :payload_style, enum: -> { Orb::PaymentMethodDeletedWebhookEvent::PayloadStyle }
24
+
18
25
  # @!attribute payment_method
19
26
  # A payment method represents a customer's stored payment instrument held with an
20
27
  # external payment provider (such as Adyen or Stripe).
@@ -36,7 +43,7 @@ module Orb
36
43
  # @return [Symbol, Orb::Models::PaymentMethodDeletedWebhookEvent::Type]
37
44
  required :type, enum: -> { Orb::PaymentMethodDeletedWebhookEvent::Type }
38
45
 
39
- # @!method initialize(id:, created_at:, payment_method:, properties:, type:)
46
+ # @!method initialize(id:, created_at:, payload_style:, payment_method:, properties:, type:)
40
47
  # Some parameter documentations has been truncated, see
41
48
  # {Orb::Models::PaymentMethodDeletedWebhookEvent} for more details.
42
49
  #
@@ -46,12 +53,28 @@ module Orb
46
53
  #
47
54
  # @param created_at [Time] The time at which this event was created, to the second.
48
55
  #
56
+ # @param payload_style [Symbol, Orb::Models::PaymentMethodDeletedWebhookEvent::PayloadStyle] The serialization style this payload was rendered in, as configured on the endpo
57
+ #
49
58
  # @param payment_method [Orb::Models::PaymentMethodDeletedWebhookEvent::PaymentMethod] A payment method represents a customer's stored payment instrument held with an
50
59
  #
51
60
  # @param properties [Object]
52
61
  #
53
62
  # @param type [Symbol, Orb::Models::PaymentMethodDeletedWebhookEvent::Type] The event this payload describes.
54
63
 
64
+ # The serialization style this payload was rendered in, as configured on the
65
+ # endpoint.
66
+ #
67
+ # @see Orb::Models::PaymentMethodDeletedWebhookEvent#payload_style
68
+ module PayloadStyle
69
+ extend Orb::Internal::Type::Enum
70
+
71
+ EXPANDED = :expanded
72
+ STANDARD = :standard
73
+
74
+ # @!method self.values
75
+ # @return [Array<Symbol>]
76
+ end
77
+
55
78
  # @see Orb::Models::PaymentMethodDeletedWebhookEvent#payment_method
56
79
  class PaymentMethod < Orb::Internal::Type::BaseModel
57
80
  # @!attribute id
@@ -0,0 +1,117 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Orb
4
+ module Models
5
+ class PlanCreatedWebhookEvent < Orb::Internal::Type::BaseModel
6
+ # @!attribute id
7
+ # The ID of this webhook event.
8
+ #
9
+ # @return [String]
10
+ required :id, String
11
+
12
+ # @!attribute created_at
13
+ # The time at which this event was created, to the second.
14
+ #
15
+ # @return [Time]
16
+ required :created_at, Time
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::PlanCreatedWebhookEvent::PayloadStyle]
23
+ required :payload_style, enum: -> { Orb::PlanCreatedWebhookEvent::PayloadStyle }
24
+
25
+ # @!attribute plan
26
+ #
27
+ # @return [Orb::Models::PlanCreatedWebhookEvent::Plan]
28
+ required :plan, -> { Orb::PlanCreatedWebhookEvent::Plan }
29
+
30
+ # @!attribute properties
31
+ #
32
+ # @return [Object]
33
+ required :properties, Orb::Internal::Type::Unknown
34
+
35
+ # @!attribute type
36
+ # The event this payload describes.
37
+ #
38
+ # @return [Symbol, Orb::Models::PlanCreatedWebhookEvent::Type]
39
+ required :type, enum: -> { Orb::PlanCreatedWebhookEvent::Type }
40
+
41
+ # @!method initialize(id:, created_at:, payload_style:, plan:, properties:, type:)
42
+ # Some parameter documentations has been truncated, see
43
+ # {Orb::Models::PlanCreatedWebhookEvent} for more details.
44
+ #
45
+ # Issued when a plan is created, or when a draft plan is published.
46
+ #
47
+ # @param id [String] The ID of this webhook event.
48
+ #
49
+ # @param created_at [Time] The time at which this event was created, to the second.
50
+ #
51
+ # @param payload_style [Symbol, Orb::Models::PlanCreatedWebhookEvent::PayloadStyle] The serialization style this payload was rendered in, as configured on the endpo
52
+ #
53
+ # @param plan [Orb::Models::PlanCreatedWebhookEvent::Plan]
54
+ #
55
+ # @param properties [Object]
56
+ #
57
+ # @param type [Symbol, Orb::Models::PlanCreatedWebhookEvent::Type] The event this payload describes.
58
+
59
+ # The serialization style this payload was rendered in, as configured on the
60
+ # endpoint.
61
+ #
62
+ # @see Orb::Models::PlanCreatedWebhookEvent#payload_style
63
+ module PayloadStyle
64
+ extend Orb::Internal::Type::Enum
65
+
66
+ EXPANDED = :expanded
67
+ STANDARD = :standard
68
+
69
+ # @!method self.values
70
+ # @return [Array<Symbol>]
71
+ end
72
+
73
+ # @see Orb::Models::PlanCreatedWebhookEvent#plan
74
+ class Plan < Orb::Internal::Type::BaseModel
75
+ # @!attribute id
76
+ #
77
+ # @return [String, nil]
78
+ required :id, String, nil?: true
79
+
80
+ # @!attribute external_plan_id
81
+ # An optional user-defined ID for this plan resource, used throughout the system
82
+ # as an alias for this Plan. Use this field to identify a plan by an existing
83
+ # identifier in your system.
84
+ #
85
+ # @return [String, nil]
86
+ required :external_plan_id, String, nil?: true
87
+
88
+ # @!attribute name
89
+ #
90
+ # @return [String, nil]
91
+ required :name, String, nil?: true
92
+
93
+ # @!method initialize(id:, external_plan_id:, name:)
94
+ # Some parameter documentations has been truncated, see
95
+ # {Orb::Models::PlanCreatedWebhookEvent::Plan} for more details.
96
+ #
97
+ # @param id [String, nil]
98
+ #
99
+ # @param external_plan_id [String, nil] An optional user-defined ID for this plan resource, used throughout the system a
100
+ #
101
+ # @param name [String, nil]
102
+ end
103
+
104
+ # The event this payload describes.
105
+ #
106
+ # @see Orb::Models::PlanCreatedWebhookEvent#type
107
+ module Type
108
+ extend Orb::Internal::Type::Enum
109
+
110
+ PLAN_CREATED = :"plan.created"
111
+
112
+ # @!method self.values
113
+ # @return [Array<Symbol>]
114
+ end
115
+ end
116
+ end
117
+ end
@@ -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::PlanDefaultVersionSetWebhookEvent::PayloadStyle]
23
+ required :payload_style, enum: -> { Orb::PlanDefaultVersionSetWebhookEvent::PayloadStyle }
24
+
18
25
  # @!attribute plan
19
26
  #
20
27
  # @return [Orb::Models::PlanDefaultVersionSetWebhookEvent::Plan]
@@ -31,19 +38,38 @@ module Orb
31
38
  # @return [Symbol, Orb::Models::PlanDefaultVersionSetWebhookEvent::Type]
32
39
  required :type, enum: -> { Orb::PlanDefaultVersionSetWebhookEvent::Type }
33
40
 
34
- # @!method initialize(id:, created_at:, plan:, properties:, type:)
41
+ # @!method initialize(id:, created_at:, payload_style:, plan:, properties:, type:)
42
+ # Some parameter documentations has been truncated, see
43
+ # {Orb::Models::PlanDefaultVersionSetWebhookEvent} for more details.
44
+ #
35
45
  # Issued when a plan's default version is set.
36
46
  #
37
47
  # @param id [String] The ID of this webhook event.
38
48
  #
39
49
  # @param created_at [Time] The time at which this event was created, to the second.
40
50
  #
51
+ # @param payload_style [Symbol, Orb::Models::PlanDefaultVersionSetWebhookEvent::PayloadStyle] The serialization style this payload was rendered in, as configured on the endpo
52
+ #
41
53
  # @param plan [Orb::Models::PlanDefaultVersionSetWebhookEvent::Plan]
42
54
  #
43
55
  # @param properties [Orb::Models::PlanDefaultVersionSetWebhookEvent::Properties]
44
56
  #
45
57
  # @param type [Symbol, Orb::Models::PlanDefaultVersionSetWebhookEvent::Type] The event this payload describes.
46
58
 
59
+ # The serialization style this payload was rendered in, as configured on the
60
+ # endpoint.
61
+ #
62
+ # @see Orb::Models::PlanDefaultVersionSetWebhookEvent#payload_style
63
+ module PayloadStyle
64
+ extend Orb::Internal::Type::Enum
65
+
66
+ EXPANDED = :expanded
67
+ STANDARD = :standard
68
+
69
+ # @!method self.values
70
+ # @return [Array<Symbol>]
71
+ end
72
+
47
73
  # @see Orb::Models::PlanDefaultVersionSetWebhookEvent#plan
48
74
  class Plan < Orb::Internal::Type::BaseModel
49
75
  # @!attribute id