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
@@ -0,0 +1,147 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Orb
4
+ module Models
5
+ module DimensionalPriceGroups
6
+ # @see Orb::Resources::DimensionalPriceGroups::Prices#create
7
+ class PriceCreateParams < Orb::Internal::Type::BaseModel
8
+ extend Orb::Internal::Type::RequestParameters::Converter
9
+ include Orb::Internal::Type::RequestParameters
10
+
11
+ # @!attribute dimensional_price_group_id
12
+ #
13
+ # @return [String]
14
+ required :dimensional_price_group_id, String
15
+
16
+ # @!attribute cadence
17
+ # Billing cadence for every price
18
+ #
19
+ # @return [Symbol, Orb::Models::DimensionalPriceGroups::PriceCreateParams::Cadence]
20
+ required :cadence, enum: -> { Orb::DimensionalPriceGroups::PriceCreateParams::Cadence }
21
+
22
+ # @!attribute currency
23
+ # An ISO 4217 currency string for every price.
24
+ #
25
+ # @return [String]
26
+ required :currency, String
27
+
28
+ # @!attribute item_id
29
+ # The item for every price. Must be the group's billable metric item.
30
+ #
31
+ # @return [String]
32
+ required :item_id, String
33
+
34
+ # @!attribute model_type
35
+ #
36
+ # @return [Symbol, Orb::Models::DimensionalPriceGroups::PriceCreateParams::ModelType]
37
+ required :model_type, enum: -> { Orb::DimensionalPriceGroups::PriceCreateParams::ModelType }
38
+
39
+ # @!attribute prices
40
+ #
41
+ # @return [Array<Orb::Models::DimensionalPriceGroups::PriceCreateParams::Price>]
42
+ required :prices,
43
+ -> { Orb::Internal::Type::ArrayOf[Orb::DimensionalPriceGroups::PriceCreateParams::Price] }
44
+
45
+ # @!attribute tiers
46
+ # Shared tier boundaries. Required for tiered prices and omitted for unit prices.
47
+ #
48
+ # @return [Array<Orb::Models::DimensionalPriceGroups::PriceCreateParams::Tier>, nil]
49
+ optional :tiers,
50
+ -> { Orb::Internal::Type::ArrayOf[Orb::DimensionalPriceGroups::PriceCreateParams::Tier] },
51
+ nil?: true
52
+
53
+ # @!method initialize(dimensional_price_group_id:, cadence:, currency:, item_id:, model_type:, prices:, tiers: nil, request_options: {})
54
+ # @param dimensional_price_group_id [String]
55
+ #
56
+ # @param cadence [Symbol, Orb::Models::DimensionalPriceGroups::PriceCreateParams::Cadence] Billing cadence for every price
57
+ #
58
+ # @param currency [String] An ISO 4217 currency string for every price.
59
+ #
60
+ # @param item_id [String] The item for every price. Must be the group's billable metric item.
61
+ #
62
+ # @param model_type [Symbol, Orb::Models::DimensionalPriceGroups::PriceCreateParams::ModelType]
63
+ #
64
+ # @param prices [Array<Orb::Models::DimensionalPriceGroups::PriceCreateParams::Price>]
65
+ #
66
+ # @param tiers [Array<Orb::Models::DimensionalPriceGroups::PriceCreateParams::Tier>, nil] Shared tier boundaries. Required for tiered prices and omitted for unit prices.
67
+ #
68
+ # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
69
+
70
+ # Billing cadence for every price
71
+ module Cadence
72
+ extend Orb::Internal::Type::Enum
73
+
74
+ ONE_TIME = :one_time
75
+ MONTHLY = :monthly
76
+ QUARTERLY = :quarterly
77
+ SEMI_ANNUAL = :semi_annual
78
+ ANNUAL = :annual
79
+
80
+ # @!method self.values
81
+ # @return [Array<Symbol>]
82
+ end
83
+
84
+ module ModelType
85
+ extend Orb::Internal::Type::Enum
86
+
87
+ UNIT = :unit
88
+ TIERED = :tiered
89
+
90
+ # @!method self.values
91
+ # @return [Array<Symbol>]
92
+ end
93
+
94
+ class Price < Orb::Internal::Type::BaseModel
95
+ # @!attribute amounts
96
+ # One amount for a unit price. One amount per tier for a tiered price, in tier
97
+ # order.
98
+ #
99
+ # @return [Array<Float>]
100
+ required :amounts, Orb::Internal::Type::ArrayOf[Float]
101
+
102
+ # @!attribute dimension_values
103
+ # Dimension values, in the group's dimension order.
104
+ #
105
+ # @return [Array<String>]
106
+ required :dimension_values, Orb::Internal::Type::ArrayOf[String]
107
+
108
+ # @!attribute name
109
+ # Price name. Defaults to the dimension values.
110
+ #
111
+ # @return [String, nil]
112
+ optional :name, String, nil?: true
113
+
114
+ # @!method initialize(amounts:, dimension_values:, name: nil)
115
+ # Some parameter documentations has been truncated, see
116
+ # {Orb::Models::DimensionalPriceGroups::PriceCreateParams::Price} for more
117
+ # details.
118
+ #
119
+ # @param amounts [Array<Float>] One amount for a unit price. One amount per tier for a tiered price, in tier ord
120
+ #
121
+ # @param dimension_values [Array<String>] Dimension values, in the group's dimension order.
122
+ #
123
+ # @param name [String, nil] Price name. Defaults to the dimension values.
124
+ end
125
+
126
+ class Tier < Orb::Internal::Type::BaseModel
127
+ # @!attribute first_unit
128
+ # Exclusive tier starting value
129
+ #
130
+ # @return [Float]
131
+ required :first_unit, Float
132
+
133
+ # @!attribute last_unit
134
+ # Inclusive tier ending value. Null on the last tier.
135
+ #
136
+ # @return [Float, nil]
137
+ optional :last_unit, Float, nil?: true
138
+
139
+ # @!method initialize(first_unit:, last_unit: nil)
140
+ # @param first_unit [Float] Exclusive tier starting value
141
+ #
142
+ # @param last_unit [Float, nil] Inclusive tier ending value. Null on the last tier.
143
+ end
144
+ end
145
+ end
146
+ end
147
+ end
@@ -0,0 +1,19 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Orb
4
+ module Models
5
+ module DimensionalPriceGroups
6
+ # @see Orb::Resources::DimensionalPriceGroups::Prices#create
7
+ class PriceCreateResponse < Orb::Internal::Type::BaseModel
8
+ # @!attribute data
9
+ # The prices created by this request, in request order.
10
+ #
11
+ # @return [Array<Orb::Models::Price::Unit, Orb::Models::Price::Tiered, Orb::Models::Price::Bulk, Orb::Models::Price::BulkWithFilters, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::GroupedTiered, Orb::Models::Price::GroupedTieredMatrix, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredMatrixWithAllocation, Orb::Models::Price::MatrixWithThresholdDiscounts, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::GroupedWithMinMaxThresholds, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk, Orb::Models::Price::CumulativeGroupedAllocation, Orb::Models::Price::DailyCreditAllowance, Orb::Models::Price::MeteredAllowance, Orb::Models::Price::MinimumComposite, Orb::Models::Price::Percent, Orb::Models::Price::EventOutput>]
12
+ required :data, -> { Orb::Internal::Type::ArrayOf[union: Orb::Price] }
13
+
14
+ # @!method initialize(data:)
15
+ # @param data [Array<Orb::Models::Price::Unit, Orb::Models::Price::Tiered, Orb::Models::Price::Bulk, Orb::Models::Price::BulkWithFilters, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::GroupedTiered, Orb::Models::Price::GroupedTieredMatrix, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredMatrixWithAllocation, Orb::Models::Price::MatrixWithThresholdDiscounts, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::GroupedWithMinMaxThresholds, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk, Orb::Models::Price::CumulativeGroupedAllocation, Orb::Models::Price::DailyCreditAllowance, Orb::Models::Price::MeteredAllowance, Orb::Models::Price::MinimumComposite, Orb::Models::Price::Percent, Orb::Models::Price::EventOutput>] The prices created by this request, in request order.
16
+ end
17
+ end
18
+ end
19
+ end
@@ -0,0 +1,65 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Orb
4
+ module Models
5
+ module DimensionalPriceGroups
6
+ # @see Orb::Resources::DimensionalPriceGroups::Prices#list
7
+ class PriceListParams < Orb::Internal::Type::BaseModel
8
+ extend Orb::Internal::Type::RequestParameters::Converter
9
+ include Orb::Internal::Type::RequestParameters
10
+
11
+ # @!attribute dimensional_price_group_id
12
+ #
13
+ # @return [String]
14
+ required :dimensional_price_group_id, String
15
+
16
+ # @!attribute cursor
17
+ # Cursor for pagination. This can be populated by the `next_cursor` value returned
18
+ # from the initial request.
19
+ #
20
+ # @return [String, nil]
21
+ optional :cursor, String, nil?: true
22
+
23
+ # @!attribute limit
24
+ # The number of items to fetch. Defaults to 20.
25
+ #
26
+ # @return [Integer, nil]
27
+ optional :limit, Integer
28
+
29
+ # @!attribute status
30
+ # active omits archived prices. archived returns only archived prices. all returns
31
+ # both.
32
+ #
33
+ # @return [Symbol, Orb::Models::DimensionalPriceGroups::PriceListParams::Status, nil]
34
+ optional :status, enum: -> { Orb::DimensionalPriceGroups::PriceListParams::Status }
35
+
36
+ # @!method initialize(dimensional_price_group_id:, cursor: nil, limit: nil, status: nil, request_options: {})
37
+ # Some parameter documentations has been truncated, see
38
+ # {Orb::Models::DimensionalPriceGroups::PriceListParams} for more details.
39
+ #
40
+ # @param dimensional_price_group_id [String]
41
+ #
42
+ # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
43
+ #
44
+ # @param limit [Integer] The number of items to fetch. Defaults to 20.
45
+ #
46
+ # @param status [Symbol, Orb::Models::DimensionalPriceGroups::PriceListParams::Status] active omits archived prices. archived returns only archived prices. all returns
47
+ #
48
+ # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
49
+
50
+ # active omits archived prices. archived returns only archived prices. all returns
51
+ # both.
52
+ module Status
53
+ extend Orb::Internal::Type::Enum
54
+
55
+ ACTIVE = :active
56
+ ARCHIVED = :archived
57
+ ALL = :all
58
+
59
+ # @!method self.values
60
+ # @return [Array<Symbol>]
61
+ end
62
+ end
63
+ end
64
+ end
65
+ 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::EventUnmatchedEventWebhookEvent::PayloadStyle]
23
+ required :payload_style, enum: -> { Orb::EventUnmatchedEventWebhookEvent::PayloadStyle }
24
+
18
25
  # @!attribute properties
19
26
  #
20
27
  # @return [Orb::Models::EventUnmatchedEventWebhookEvent::Properties]
@@ -26,17 +33,36 @@ module Orb
26
33
  # @return [Symbol, Orb::Models::EventUnmatchedEventWebhookEvent::Type]
27
34
  required :type, enum: -> { Orb::EventUnmatchedEventWebhookEvent::Type }
28
35
 
29
- # @!method initialize(id:, created_at:, properties:, type:)
36
+ # @!method initialize(id:, created_at:, payload_style:, properties:, type:)
37
+ # Some parameter documentations has been truncated, see
38
+ # {Orb::Models::EventUnmatchedEventWebhookEvent} for more details.
39
+ #
30
40
  # Issued when an event does not match any customer.
31
41
  #
32
42
  # @param id [String] The ID of this webhook event.
33
43
  #
34
44
  # @param created_at [Time] The time at which this event was created, to the second.
35
45
  #
46
+ # @param payload_style [Symbol, Orb::Models::EventUnmatchedEventWebhookEvent::PayloadStyle] The serialization style this payload was rendered in, as configured on the endpo
47
+ #
36
48
  # @param properties [Orb::Models::EventUnmatchedEventWebhookEvent::Properties]
37
49
  #
38
50
  # @param type [Symbol, Orb::Models::EventUnmatchedEventWebhookEvent::Type] The event this payload describes.
39
51
 
52
+ # The serialization style this payload was rendered in, as configured on the
53
+ # endpoint.
54
+ #
55
+ # @see Orb::Models::EventUnmatchedEventWebhookEvent#payload_style
56
+ module PayloadStyle
57
+ extend Orb::Internal::Type::Enum
58
+
59
+ EXPANDED = :expanded
60
+ STANDARD = :standard
61
+
62
+ # @!method self.values
63
+ # @return [Array<Symbol>]
64
+ end
65
+
40
66
  # @see Orb::Models::EventUnmatchedEventWebhookEvent#properties
41
67
  class Properties < Orb::Internal::Type::BaseModel
42
68
  # @!attribute event
@@ -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::IngestionUnmatchedCustomerIDsWebhookEvent::PayloadStyle]
23
+ required :payload_style, enum: -> { Orb::IngestionUnmatchedCustomerIDsWebhookEvent::PayloadStyle }
24
+
18
25
  # @!attribute properties
19
26
  #
20
27
  # @return [Orb::Models::IngestionUnmatchedCustomerIDsWebhookEvent::Properties]
@@ -26,17 +33,36 @@ module Orb
26
33
  # @return [Symbol, Orb::Models::IngestionUnmatchedCustomerIDsWebhookEvent::Type]
27
34
  required :type, enum: -> { Orb::IngestionUnmatchedCustomerIDsWebhookEvent::Type }
28
35
 
29
- # @!method initialize(id:, created_at:, properties:, type:)
36
+ # @!method initialize(id:, created_at:, payload_style:, properties:, type:)
37
+ # Some parameter documentations has been truncated, see
38
+ # {Orb::Models::IngestionUnmatchedCustomerIDsWebhookEvent} for more details.
39
+ #
30
40
  # Issued when ingestion events reference unmatched customer IDs.
31
41
  #
32
42
  # @param id [String] The ID of this webhook event.
33
43
  #
34
44
  # @param created_at [Time] The time at which this event was created, to the second.
35
45
  #
46
+ # @param payload_style [Symbol, Orb::Models::IngestionUnmatchedCustomerIDsWebhookEvent::PayloadStyle] The serialization style this payload was rendered in, as configured on the endpo
47
+ #
36
48
  # @param properties [Orb::Models::IngestionUnmatchedCustomerIDsWebhookEvent::Properties]
37
49
  #
38
50
  # @param type [Symbol, Orb::Models::IngestionUnmatchedCustomerIDsWebhookEvent::Type] The event this payload describes.
39
51
 
52
+ # The serialization style this payload was rendered in, as configured on the
53
+ # endpoint.
54
+ #
55
+ # @see Orb::Models::IngestionUnmatchedCustomerIDsWebhookEvent#payload_style
56
+ module PayloadStyle
57
+ extend Orb::Internal::Type::Enum
58
+
59
+ EXPANDED = :expanded
60
+ STANDARD = :standard
61
+
62
+ # @!method self.values
63
+ # @return [Array<Symbol>]
64
+ end
65
+
40
66
  # @see Orb::Models::IngestionUnmatchedCustomerIDsWebhookEvent#properties
41
67
  class Properties < Orb::Internal::Type::BaseModel
42
68
  # @!attribute external_customer_ids
@@ -31,6 +31,13 @@ module Orb
31
31
  # @return [Orb::Models::Invoice]
32
32
  required :invoice, -> { Orb::Invoice }
33
33
 
34
+ # @!attribute payload_style
35
+ # The serialization style this payload was rendered in, as configured on the
36
+ # endpoint.
37
+ #
38
+ # @return [Symbol, Orb::Models::InvoiceAccountingSyncFailedWebhookEvent::PayloadStyle]
39
+ required :payload_style, enum: -> { Orb::InvoiceAccountingSyncFailedWebhookEvent::PayloadStyle }
40
+
34
41
  # @!attribute properties
35
42
  #
36
43
  # @return [Orb::Models::InvoiceAccountingSyncFailedWebhookEvent::Properties]
@@ -42,7 +49,7 @@ module Orb
42
49
  # @return [Symbol, Orb::Models::InvoiceAccountingSyncFailedWebhookEvent::Type]
43
50
  required :type, enum: -> { Orb::InvoiceAccountingSyncFailedWebhookEvent::Type }
44
51
 
45
- # @!method initialize(id:, accounting_sync_record:, created_at:, invoice:, properties:, type:)
52
+ # @!method initialize(id:, accounting_sync_record:, created_at:, invoice:, payload_style:, properties:, type:)
46
53
  # Some parameter documentations has been truncated, see
47
54
  # {Orb::Models::InvoiceAccountingSyncFailedWebhookEvent} for more details.
48
55
  #
@@ -56,6 +63,8 @@ module Orb
56
63
  #
57
64
  # @param invoice [Orb::Models::Invoice] An [`Invoice`](/core-concepts#invoice) is a fundamental billing entity, represen
58
65
  #
66
+ # @param payload_style [Symbol, Orb::Models::InvoiceAccountingSyncFailedWebhookEvent::PayloadStyle] The serialization style this payload was rendered in, as configured on the endpo
67
+ #
59
68
  # @param properties [Orb::Models::InvoiceAccountingSyncFailedWebhookEvent::Properties]
60
69
  #
61
70
  # @param type [Symbol, Orb::Models::InvoiceAccountingSyncFailedWebhookEvent::Type] The event this payload describes.
@@ -131,6 +140,20 @@ module Orb
131
140
  end
132
141
  end
133
142
 
143
+ # The serialization style this payload was rendered in, as configured on the
144
+ # endpoint.
145
+ #
146
+ # @see Orb::Models::InvoiceAccountingSyncFailedWebhookEvent#payload_style
147
+ module PayloadStyle
148
+ extend Orb::Internal::Type::Enum
149
+
150
+ EXPANDED = :expanded
151
+ STANDARD = :standard
152
+
153
+ # @!method self.values
154
+ # @return [Array<Symbol>]
155
+ end
156
+
134
157
  # @see Orb::Models::InvoiceAccountingSyncFailedWebhookEvent#properties
135
158
  class Properties < Orb::Internal::Type::BaseModel
136
159
  # @!attribute connection_type
@@ -31,6 +31,13 @@ module Orb
31
31
  # @return [Orb::Models::Invoice]
32
32
  required :invoice, -> { Orb::Invoice }
33
33
 
34
+ # @!attribute payload_style
35
+ # The serialization style this payload was rendered in, as configured on the
36
+ # endpoint.
37
+ #
38
+ # @return [Symbol, Orb::Models::InvoiceAccountingSyncSucceededWebhookEvent::PayloadStyle]
39
+ required :payload_style, enum: -> { Orb::InvoiceAccountingSyncSucceededWebhookEvent::PayloadStyle }
40
+
34
41
  # @!attribute properties
35
42
  #
36
43
  # @return [Orb::Models::InvoiceAccountingSyncSucceededWebhookEvent::Properties]
@@ -42,7 +49,7 @@ module Orb
42
49
  # @return [Symbol, Orb::Models::InvoiceAccountingSyncSucceededWebhookEvent::Type]
43
50
  required :type, enum: -> { Orb::InvoiceAccountingSyncSucceededWebhookEvent::Type }
44
51
 
45
- # @!method initialize(id:, accounting_sync_record:, created_at:, invoice:, properties:, type:)
52
+ # @!method initialize(id:, accounting_sync_record:, created_at:, invoice:, payload_style:, properties:, type:)
46
53
  # Some parameter documentations has been truncated, see
47
54
  # {Orb::Models::InvoiceAccountingSyncSucceededWebhookEvent} for more details.
48
55
  #
@@ -56,6 +63,8 @@ module Orb
56
63
  #
57
64
  # @param invoice [Orb::Models::Invoice] An [`Invoice`](/core-concepts#invoice) is a fundamental billing entity, represen
58
65
  #
66
+ # @param payload_style [Symbol, Orb::Models::InvoiceAccountingSyncSucceededWebhookEvent::PayloadStyle] The serialization style this payload was rendered in, as configured on the endpo
67
+ #
59
68
  # @param properties [Orb::Models::InvoiceAccountingSyncSucceededWebhookEvent::Properties]
60
69
  #
61
70
  # @param type [Symbol, Orb::Models::InvoiceAccountingSyncSucceededWebhookEvent::Type] The event this payload describes.
@@ -131,6 +140,20 @@ module Orb
131
140
  end
132
141
  end
133
142
 
143
+ # The serialization style this payload was rendered in, as configured on the
144
+ # endpoint.
145
+ #
146
+ # @see Orb::Models::InvoiceAccountingSyncSucceededWebhookEvent#payload_style
147
+ module PayloadStyle
148
+ extend Orb::Internal::Type::Enum
149
+
150
+ EXPANDED = :expanded
151
+ STANDARD = :standard
152
+
153
+ # @!method self.values
154
+ # @return [Array<Symbol>]
155
+ end
156
+
134
157
  # @see Orb::Models::InvoiceAccountingSyncSucceededWebhookEvent#properties
135
158
  class Properties < Orb::Internal::Type::BaseModel
136
159
  # @!attribute connection_type
@@ -23,6 +23,13 @@ module Orb
23
23
  # @return [Orb::Models::InvoiceAutomationScheduleStepExecutedWebhookEvent::Invoice]
24
24
  required :invoice, -> { Orb::InvoiceAutomationScheduleStepExecutedWebhookEvent::Invoice }
25
25
 
26
+ # @!attribute payload_style
27
+ # The serialization style this payload was rendered in, as configured on the
28
+ # endpoint.
29
+ #
30
+ # @return [Symbol, Orb::Models::InvoiceAutomationScheduleStepExecutedWebhookEvent::PayloadStyle]
31
+ required :payload_style, enum: -> { Orb::InvoiceAutomationScheduleStepExecutedWebhookEvent::PayloadStyle }
32
+
26
33
  # @!attribute properties
27
34
  #
28
35
  # @return [Orb::Models::InvoiceAutomationScheduleStepExecutedWebhookEvent::Properties]
@@ -34,7 +41,7 @@ module Orb
34
41
  # @return [Symbol, Orb::Models::InvoiceAutomationScheduleStepExecutedWebhookEvent::Type]
35
42
  required :type, enum: -> { Orb::InvoiceAutomationScheduleStepExecutedWebhookEvent::Type }
36
43
 
37
- # @!method initialize(id:, created_at:, invoice:, properties:, type:)
44
+ # @!method initialize(id:, created_at:, invoice:, payload_style:, properties:, type:)
38
45
  # Some parameter documentations has been truncated, see
39
46
  # {Orb::Models::InvoiceAutomationScheduleStepExecutedWebhookEvent} for more
40
47
  # details.
@@ -47,6 +54,8 @@ module Orb
47
54
  #
48
55
  # @param invoice [Orb::Models::InvoiceAutomationScheduleStepExecutedWebhookEvent::Invoice] The invoice fields a consumer needs to run their own notification flows without
49
56
  #
57
+ # @param payload_style [Symbol, Orb::Models::InvoiceAutomationScheduleStepExecutedWebhookEvent::PayloadStyle] The serialization style this payload was rendered in, as configured on the endpo
58
+ #
50
59
  # @param properties [Orb::Models::InvoiceAutomationScheduleStepExecutedWebhookEvent::Properties]
51
60
  #
52
61
  # @param type [Symbol, Orb::Models::InvoiceAutomationScheduleStepExecutedWebhookEvent::Type] The event this payload describes.
@@ -150,6 +159,20 @@ module Orb
150
159
  # @param subscription_id [String, nil]
151
160
  end
152
161
 
162
+ # The serialization style this payload was rendered in, as configured on the
163
+ # endpoint.
164
+ #
165
+ # @see Orb::Models::InvoiceAutomationScheduleStepExecutedWebhookEvent#payload_style
166
+ module PayloadStyle
167
+ extend Orb::Internal::Type::Enum
168
+
169
+ EXPANDED = :expanded
170
+ STANDARD = :standard
171
+
172
+ # @!method self.values
173
+ # @return [Array<Symbol>]
174
+ end
175
+
153
176
  # @see Orb::Models::InvoiceAutomationScheduleStepExecutedWebhookEvent#properties
154
177
  class Properties < Orb::Internal::Type::BaseModel
155
178
  # @!attribute actions
@@ -20,6 +20,13 @@ module Orb
20
20
  # @return [String]
21
21
  required :invoice, String
22
22
 
23
+ # @!attribute payload_style
24
+ # The serialization style this payload was rendered in, as configured on the
25
+ # endpoint.
26
+ #
27
+ # @return [Symbol, Orb::Models::InvoiceCostDataExportedWebhookEvent::PayloadStyle]
28
+ required :payload_style, enum: -> { Orb::InvoiceCostDataExportedWebhookEvent::PayloadStyle }
29
+
23
30
  # @!attribute properties
24
31
  #
25
32
  # @return [Orb::Models::InvoiceCostDataExportedWebhookEvent::Properties]
@@ -31,7 +38,10 @@ module Orb
31
38
  # @return [Symbol, Orb::Models::InvoiceCostDataExportedWebhookEvent::Type]
32
39
  required :type, enum: -> { Orb::InvoiceCostDataExportedWebhookEvent::Type }
33
40
 
34
- # @!method initialize(id:, created_at:, invoice:, properties:, type:)
41
+ # @!method initialize(id:, created_at:, invoice:, payload_style:, properties:, type:)
42
+ # Some parameter documentations has been truncated, see
43
+ # {Orb::Models::InvoiceCostDataExportedWebhookEvent} for more details.
44
+ #
35
45
  # Issued when invoice cost data is exported.
36
46
  #
37
47
  # @param id [String] The ID of this webhook event.
@@ -40,10 +50,26 @@ module Orb
40
50
  #
41
51
  # @param invoice [String]
42
52
  #
53
+ # @param payload_style [Symbol, Orb::Models::InvoiceCostDataExportedWebhookEvent::PayloadStyle] The serialization style this payload was rendered in, as configured on the endpo
54
+ #
43
55
  # @param properties [Orb::Models::InvoiceCostDataExportedWebhookEvent::Properties]
44
56
  #
45
57
  # @param type [Symbol, Orb::Models::InvoiceCostDataExportedWebhookEvent::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::InvoiceCostDataExportedWebhookEvent#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::InvoiceCostDataExportedWebhookEvent#properties
48
74
  class Properties < Orb::Internal::Type::BaseModel
49
75
  # @!attribute exported_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::InvoiceDueDateRecalculationCanceledWebhookEvent::PayloadStyle]
23
+ required :payload_style, enum: -> { Orb::InvoiceDueDateRecalculationCanceledWebhookEvent::PayloadStyle }
24
+
18
25
  # @!attribute properties
19
26
  #
20
27
  # @return [Orb::Models::InvoiceDueDateRecalculationCanceledWebhookEvent::Properties]
@@ -26,17 +33,36 @@ module Orb
26
33
  # @return [Symbol, Orb::Models::InvoiceDueDateRecalculationCanceledWebhookEvent::Type]
27
34
  required :type, enum: -> { Orb::InvoiceDueDateRecalculationCanceledWebhookEvent::Type }
28
35
 
29
- # @!method initialize(id:, created_at:, properties:, type:)
36
+ # @!method initialize(id:, created_at:, payload_style:, properties:, type:)
37
+ # Some parameter documentations has been truncated, see
38
+ # {Orb::Models::InvoiceDueDateRecalculationCanceledWebhookEvent} for more details.
39
+ #
30
40
  # Issued when an invoice due date recalculation is canceled.
31
41
  #
32
42
  # @param id [String] The ID of this webhook event.
33
43
  #
34
44
  # @param created_at [Time] The time at which this event was created, to the second.
35
45
  #
46
+ # @param payload_style [Symbol, Orb::Models::InvoiceDueDateRecalculationCanceledWebhookEvent::PayloadStyle] The serialization style this payload was rendered in, as configured on the endpo
47
+ #
36
48
  # @param properties [Orb::Models::InvoiceDueDateRecalculationCanceledWebhookEvent::Properties]
37
49
  #
38
50
  # @param type [Symbol, Orb::Models::InvoiceDueDateRecalculationCanceledWebhookEvent::Type] The event this payload describes.
39
51
 
52
+ # The serialization style this payload was rendered in, as configured on the
53
+ # endpoint.
54
+ #
55
+ # @see Orb::Models::InvoiceDueDateRecalculationCanceledWebhookEvent#payload_style
56
+ module PayloadStyle
57
+ extend Orb::Internal::Type::Enum
58
+
59
+ EXPANDED = :expanded
60
+ STANDARD = :standard
61
+
62
+ # @!method self.values
63
+ # @return [Array<Symbol>]
64
+ end
65
+
40
66
  # @see Orb::Models::InvoiceDueDateRecalculationCanceledWebhookEvent#properties
41
67
  class Properties < Orb::Internal::Type::BaseModel
42
68
  # @!attribute canceled_at
@@ -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::InvoiceDueDateRecalculationCompletedWebhookEvent::PayloadStyle]
23
+ required :payload_style, enum: -> { Orb::InvoiceDueDateRecalculationCompletedWebhookEvent::PayloadStyle }
24
+
18
25
  # @!attribute properties
19
26
  #
20
27
  # @return [Orb::Models::InvoiceDueDateRecalculationCompletedWebhookEvent::Properties]
@@ -26,17 +33,37 @@ module Orb
26
33
  # @return [Symbol, Orb::Models::InvoiceDueDateRecalculationCompletedWebhookEvent::Type]
27
34
  required :type, enum: -> { Orb::InvoiceDueDateRecalculationCompletedWebhookEvent::Type }
28
35
 
29
- # @!method initialize(id:, created_at:, properties:, type:)
36
+ # @!method initialize(id:, created_at:, payload_style:, properties:, type:)
37
+ # Some parameter documentations has been truncated, see
38
+ # {Orb::Models::InvoiceDueDateRecalculationCompletedWebhookEvent} for more
39
+ # details.
40
+ #
30
41
  # Issued when an invoice due date recalculation is completed.
31
42
  #
32
43
  # @param id [String] The ID of this webhook event.
33
44
  #
34
45
  # @param created_at [Time] The time at which this event was created, to the second.
35
46
  #
47
+ # @param payload_style [Symbol, Orb::Models::InvoiceDueDateRecalculationCompletedWebhookEvent::PayloadStyle] The serialization style this payload was rendered in, as configured on the endpo
48
+ #
36
49
  # @param properties [Orb::Models::InvoiceDueDateRecalculationCompletedWebhookEvent::Properties]
37
50
  #
38
51
  # @param type [Symbol, Orb::Models::InvoiceDueDateRecalculationCompletedWebhookEvent::Type] The event this payload describes.
39
52
 
53
+ # The serialization style this payload was rendered in, as configured on the
54
+ # endpoint.
55
+ #
56
+ # @see Orb::Models::InvoiceDueDateRecalculationCompletedWebhookEvent#payload_style
57
+ module PayloadStyle
58
+ extend Orb::Internal::Type::Enum
59
+
60
+ EXPANDED = :expanded
61
+ STANDARD = :standard
62
+
63
+ # @!method self.values
64
+ # @return [Array<Symbol>]
65
+ end
66
+
40
67
  # @see Orb::Models::InvoiceDueDateRecalculationCompletedWebhookEvent#properties
41
68
  class Properties < Orb::Internal::Type::BaseModel
42
69
  # @!attribute completed_at