orb-billing 1.45.0 → 1.47.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +29 -1
- data/README.md +1 -1
- data/lib/orb/models/invoice_issue_summary_response.rb +2 -1
- data/lib/orb/models/invoice_issued_summary_webhook_event.rb +5 -3
- data/lib/orb/models/invoice_list_summary_response.rb +2 -1
- data/lib/orb/models/metric_list_params.rb +21 -1
- data/lib/orb/models/metric_update_params.rb +17 -1
- data/lib/orb/models/plan_update_params.rb +9 -1
- data/lib/orb/models/plans/external_plan_id_update_params.rb +9 -1
- data/lib/orb/models/subscription_alert_disabled_webhook_event.rb +5 -9
- data/lib/orb/models/subscription_grouped_cost_exceeded_webhook_event.rb +5 -9
- data/lib/orb/models/subscription_invoicing_threshold_exceeded_webhook_event.rb +5 -9
- data/lib/orb/models/subscription_license_allocation_reset_webhook_event.rb +5 -9
- data/lib/orb/models/subscription_license_balance_threshold_reached_webhook_event.rb +5 -9
- data/lib/orb/models/webhook_endpoint.rb +28 -1
- data/lib/orb/models/webhook_endpoint_create_params.rb +22 -1
- data/lib/orb/models/webhook_endpoint_update_params.rb +22 -1
- data/lib/orb/models/webhook_endpoint_with_secret.rb +28 -1
- data/lib/orb/models/webhooks/backfill_reflected_standard_webhook_event.rb +206 -0
- data/lib/orb/models/webhooks/backfill_reverted_standard_webhook_event.rb +206 -0
- data/lib/orb/models/webhooks/billable_metric_edited_standard_webhook_event.rb +131 -0
- data/lib/orb/models/webhooks/credit_block_accounting_sync_failed_standard_webhook_event.rb +537 -0
- data/lib/orb/models/webhooks/credit_block_accounting_sync_succeeded_standard_webhook_event.rb +531 -0
- data/lib/orb/models/webhooks/credit_note_accounting_sync_failed_standard_webhook_event.rb +188 -0
- data/lib/orb/models/webhooks/credit_note_accounting_sync_succeeded_standard_webhook_event.rb +183 -0
- data/lib/orb/models/webhooks/credit_note_issued_standard_webhook_event.rb +90 -0
- data/lib/orb/models/webhooks/credit_note_marked_as_void_standard_webhook_event.rb +92 -0
- data/lib/orb/models/webhooks/customer_accounting_sync_failed_standard_webhook_event.rb +198 -0
- data/lib/orb/models/webhooks/customer_accounting_sync_succeeded_standard_webhook_event.rb +193 -0
- data/lib/orb/models/webhooks/customer_balance_transaction_created_standard_webhook_event.rb +240 -0
- data/lib/orb/models/webhooks/customer_created_standard_webhook_event.rb +106 -0
- data/lib/orb/models/webhooks/customer_credit_balance_depleted_standard_webhook_event.rb +597 -0
- data/lib/orb/models/webhooks/customer_credit_balance_dropped_standard_webhook_event.rb +603 -0
- data/lib/orb/models/webhooks/customer_credit_balance_recovered_standard_webhook_event.rb +597 -0
- data/lib/orb/models/webhooks/customer_credit_ledger_incremented_standard_webhook_event.rb +509 -0
- data/lib/orb/models/webhooks/customer_edited_standard_webhook_event.rb +371 -0
- data/lib/orb/models/webhooks/data_exports_transfer_error_standard_webhook_event.rb +130 -0
- data/lib/orb/models/webhooks/data_exports_transfer_success_standard_webhook_event.rb +124 -0
- data/lib/orb/models/webhooks/event_unmatched_event_standard_webhook_event.rb +134 -0
- data/lib/orb/models/webhooks/ingestion_unmatched_customer_ids_standard_webhook_event.rb +94 -0
- data/lib/orb/models/webhooks/invoice_accounting_sync_failed_standard_webhook_event.rb +974 -0
- data/lib/orb/models/webhooks/invoice_accounting_sync_succeeded_standard_webhook_event.rb +968 -0
- data/lib/orb/models/webhooks/invoice_automation_schedule_step_executed_standard_webhook_event.rb +367 -0
- data/lib/orb/models/webhooks/invoice_cost_data_exported_standard_webhook_event.rb +113 -0
- data/lib/orb/models/webhooks/invoice_due_date_recalculation_canceled_standard_webhook_event.rb +101 -0
- data/lib/orb/models/webhooks/invoice_due_date_recalculation_completed_standard_webhook_event.rb +101 -0
- data/lib/orb/models/webhooks/invoice_due_date_recalculation_started_standard_webhook_event.rb +95 -0
- data/lib/orb/models/webhooks/invoice_dunning_schedule_created_standard_webhook_event.rb +996 -0
- data/lib/orb/models/webhooks/invoice_dunning_schedule_ended_standard_webhook_event.rb +990 -0
- data/lib/orb/models/webhooks/invoice_dunning_schedule_reset_standard_webhook_event.rb +994 -0
- data/lib/orb/models/webhooks/invoice_dunning_schedule_step_executed_standard_webhook_event.rb +944 -0
- data/lib/orb/models/webhooks/invoice_edited_standard_webhook_event.rb +1367 -0
- data/lib/orb/models/webhooks/invoice_invoice_date_elapsed_standard_webhook_event.rb +151 -0
- data/lib/orb/models/webhooks/invoice_issue_failed_standard_webhook_event.rb +887 -0
- data/lib/orb/models/webhooks/invoice_issued_standard_webhook_event.rb +886 -0
- data/lib/orb/models/webhooks/invoice_issued_summary_standard_webhook_event.rb +889 -0
- data/lib/orb/models/webhooks/invoice_manually_marked_as_paid_standard_webhook_event.rb +901 -0
- data/lib/orb/models/webhooks/invoice_manually_marked_as_void_standard_webhook_event.rb +878 -0
- data/lib/orb/models/webhooks/invoice_payment_failed_standard_webhook_event.rb +901 -0
- data/lib/orb/models/webhooks/invoice_payment_processing_standard_webhook_event.rb +895 -0
- data/lib/orb/models/webhooks/invoice_payment_succeeded_standard_webhook_event.rb +910 -0
- data/lib/orb/models/webhooks/invoice_sync_failed_standard_webhook_event.rb +892 -0
- data/lib/orb/models/webhooks/invoice_sync_succeeded_standard_webhook_event.rb +894 -0
- data/lib/orb/models/webhooks/invoice_undo_mark_as_paid_standard_webhook_event.rb +877 -0
- data/lib/orb/models/webhooks/metric_events_dropped_by_watermark_standard_webhook_event.rb +125 -0
- data/lib/orb/models/webhooks/payment_method_created_standard_webhook_event.rb +184 -0
- data/lib/orb/models/webhooks/payment_method_deleted_standard_webhook_event.rb +184 -0
- data/lib/orb/models/webhooks/plan_created_standard_webhook_event.rb +119 -0
- data/lib/orb/models/webhooks/plan_default_version_set_standard_webhook_event.rb +139 -0
- data/lib/orb/models/webhooks/plan_edited_standard_webhook_event.rb +159 -0
- data/lib/orb/models/webhooks/plan_version_created_standard_webhook_event.rb +138 -0
- data/lib/orb/models/webhooks/price_edited_standard_webhook_event.rb +132 -0
- data/lib/orb/models/webhooks/resource_event_test_standard_webhook_event.rb +92 -0
- data/lib/orb/models/webhooks/sales_order_accounting_sync_failed_standard_webhook_event.rb +974 -0
- data/lib/orb/models/webhooks/sales_order_accounting_sync_succeeded_standard_webhook_event.rb +969 -0
- data/lib/orb/models/webhooks/standard_unwrap_standard_params.rb +16 -0
- data/lib/orb/models/webhooks/subscription_accounting_sync_failed_standard_webhook_event.rb +322 -0
- data/lib/orb/models/webhooks/subscription_accounting_sync_succeeded_standard_webhook_event.rb +316 -0
- data/lib/orb/models/webhooks/subscription_alert_disabled_standard_webhook_event.rb +663 -0
- data/lib/orb/models/webhooks/subscription_cancellation_scheduled_standard_webhook_event.rb +237 -0
- data/lib/orb/models/webhooks/subscription_cancellation_unscheduled_standard_webhook_event.rb +237 -0
- data/lib/orb/models/webhooks/subscription_cost_exceeded_standard_webhook_event.rb +692 -0
- data/lib/orb/models/webhooks/subscription_created_standard_webhook_event.rb +221 -0
- data/lib/orb/models/webhooks/subscription_edited_standard_webhook_event.rb +273 -0
- data/lib/orb/models/webhooks/subscription_ended_standard_webhook_event.rb +219 -0
- data/lib/orb/models/webhooks/subscription_fixed_fee_quantity_updated_standard_webhook_event.rb +255 -0
- data/lib/orb/models/webhooks/subscription_grouped_cost_exceeded_standard_webhook_event.rb +689 -0
- data/lib/orb/models/webhooks/subscription_invoicing_threshold_exceeded_standard_webhook_event.rb +218 -0
- data/lib/orb/models/webhooks/subscription_license_allocation_reset_standard_webhook_event.rb +240 -0
- data/lib/orb/models/webhooks/subscription_license_balance_threshold_reached_standard_webhook_event.rb +683 -0
- data/lib/orb/models/webhooks/subscription_plan_change_scheduled_standard_webhook_event.rb +249 -0
- data/lib/orb/models/webhooks/subscription_plan_changed_standard_webhook_event.rb +233 -0
- data/lib/orb/models/webhooks/subscription_plan_version_change_scheduled_standard_webhook_event.rb +250 -0
- data/lib/orb/models/webhooks/subscription_plan_version_changed_standard_webhook_event.rb +248 -0
- data/lib/orb/models/webhooks/subscription_spend_exceeded_standard_webhook_event.rb +693 -0
- data/lib/orb/models/webhooks/subscription_started_standard_webhook_event.rb +221 -0
- data/lib/orb/models/webhooks/subscription_trial_ended_standard_webhook_event.rb +222 -0
- data/lib/orb/models/webhooks/subscription_usage_exceeded_standard_webhook_event.rb +700 -0
- data/lib/orb/models/webhooks/transaction_accounting_sync_failed_standard_webhook_event.rb +270 -0
- data/lib/orb/models/webhooks/transaction_accounting_sync_succeeded_standard_webhook_event.rb +264 -0
- data/lib/orb/models/webhooks/unwrap_standard_webhook_event.rb +258 -0
- data/lib/orb/models.rb +2 -0
- data/lib/orb/resources/metrics.rb +15 -5
- data/lib/orb/resources/plans/external_plan_id.rb +6 -3
- data/lib/orb/resources/plans.rb +6 -3
- data/lib/orb/resources/webhook_endpoints.rb +6 -2
- data/lib/orb/resources/webhooks/standard.rb +24 -0
- data/lib/orb/resources/webhooks.rb +4 -0
- data/lib/orb/version.rb +1 -1
- data/lib/orb.rb +84 -0
- data/rbi/orb/models/invoice_issue_summary_response.rbi +2 -1
- data/rbi/orb/models/invoice_issued_summary_webhook_event.rbi +6 -3
- data/rbi/orb/models/invoice_list_summary_response.rbi +2 -1
- data/rbi/orb/models/metric_list_params.rbi +29 -0
- data/rbi/orb/models/metric_update_params.rbi +16 -0
- data/rbi/orb/models/plan_update_params.rbi +8 -0
- data/rbi/orb/models/plans/external_plan_id_update_params.rbi +8 -0
- data/rbi/orb/models/subscription_alert_disabled_webhook_event.rbi +6 -12
- data/rbi/orb/models/subscription_grouped_cost_exceeded_webhook_event.rbi +6 -12
- data/rbi/orb/models/subscription_invoicing_threshold_exceeded_webhook_event.rbi +6 -12
- data/rbi/orb/models/subscription_license_allocation_reset_webhook_event.rbi +6 -12
- data/rbi/orb/models/subscription_license_balance_threshold_reached_webhook_event.rbi +6 -12
- data/rbi/orb/models/webhook_endpoint.rbi +39 -0
- data/rbi/orb/models/webhook_endpoint_create_params.rbi +51 -0
- data/rbi/orb/models/webhook_endpoint_update_params.rbi +51 -0
- data/rbi/orb/models/webhook_endpoint_with_secret.rbi +50 -0
- data/rbi/orb/models/webhooks/backfill_reflected_standard_webhook_event.rbi +349 -0
- data/rbi/orb/models/webhooks/backfill_reverted_standard_webhook_event.rbi +347 -0
- data/rbi/orb/models/webhooks/billable_metric_edited_standard_webhook_event.rbi +273 -0
- data/rbi/orb/models/webhooks/credit_block_accounting_sync_failed_standard_webhook_event.rbi +1106 -0
- data/rbi/orb/models/webhooks/credit_block_accounting_sync_succeeded_standard_webhook_event.rbi +1095 -0
- data/rbi/orb/models/webhooks/credit_note_accounting_sync_failed_standard_webhook_event.rbi +377 -0
- data/rbi/orb/models/webhooks/credit_note_accounting_sync_succeeded_standard_webhook_event.rbi +366 -0
- data/rbi/orb/models/webhooks/credit_note_issued_standard_webhook_event.rbi +166 -0
- data/rbi/orb/models/webhooks/credit_note_marked_as_void_standard_webhook_event.rbi +166 -0
- data/rbi/orb/models/webhooks/customer_accounting_sync_failed_standard_webhook_event.rbi +403 -0
- data/rbi/orb/models/webhooks/customer_accounting_sync_succeeded_standard_webhook_event.rbi +392 -0
- data/rbi/orb/models/webhooks/customer_balance_transaction_created_standard_webhook_event.rbi +493 -0
- data/rbi/orb/models/webhooks/customer_created_standard_webhook_event.rbi +198 -0
- data/rbi/orb/models/webhooks/customer_credit_balance_depleted_standard_webhook_event.rbi +1151 -0
- data/rbi/orb/models/webhooks/customer_credit_balance_dropped_standard_webhook_event.rbi +1158 -0
- data/rbi/orb/models/webhooks/customer_credit_balance_recovered_standard_webhook_event.rbi +1151 -0
- data/rbi/orb/models/webhooks/customer_credit_ledger_incremented_standard_webhook_event.rbi +1044 -0
- data/rbi/orb/models/webhooks/customer_edited_standard_webhook_event.rbi +678 -0
- data/rbi/orb/models/webhooks/data_exports_transfer_error_standard_webhook_event.rbi +236 -0
- data/rbi/orb/models/webhooks/data_exports_transfer_success_standard_webhook_event.rbi +230 -0
- data/rbi/orb/models/webhooks/event_unmatched_event_standard_webhook_event.rbi +275 -0
- data/rbi/orb/models/webhooks/ingestion_unmatched_customer_ids_standard_webhook_event.rbi +192 -0
- data/rbi/orb/models/webhooks/invoice_accounting_sync_failed_standard_webhook_event.rbi +1708 -0
- data/rbi/orb/models/webhooks/invoice_accounting_sync_succeeded_standard_webhook_event.rbi +1697 -0
- data/rbi/orb/models/webhooks/invoice_automation_schedule_step_executed_standard_webhook_event.rbi +670 -0
- data/rbi/orb/models/webhooks/invoice_cost_data_exported_standard_webhook_event.rbi +210 -0
- data/rbi/orb/models/webhooks/invoice_due_date_recalculation_canceled_standard_webhook_event.rbi +195 -0
- data/rbi/orb/models/webhooks/invoice_due_date_recalculation_completed_standard_webhook_event.rbi +195 -0
- data/rbi/orb/models/webhooks/invoice_due_date_recalculation_started_standard_webhook_event.rbi +188 -0
- data/rbi/orb/models/webhooks/invoice_dunning_schedule_created_standard_webhook_event.rbi +1716 -0
- data/rbi/orb/models/webhooks/invoice_dunning_schedule_ended_standard_webhook_event.rbi +1711 -0
- data/rbi/orb/models/webhooks/invoice_dunning_schedule_reset_standard_webhook_event.rbi +1716 -0
- data/rbi/orb/models/webhooks/invoice_dunning_schedule_step_executed_standard_webhook_event.rbi +1631 -0
- data/rbi/orb/models/webhooks/invoice_edited_standard_webhook_event.rbi +2340 -0
- data/rbi/orb/models/webhooks/invoice_invoice_date_elapsed_standard_webhook_event.rbi +324 -0
- data/rbi/orb/models/webhooks/invoice_issue_failed_standard_webhook_event.rbi +1532 -0
- data/rbi/orb/models/webhooks/invoice_issued_standard_webhook_event.rbi +1532 -0
- data/rbi/orb/models/webhooks/invoice_issued_summary_standard_webhook_event.rbi +1537 -0
- data/rbi/orb/models/webhooks/invoice_manually_marked_as_paid_standard_webhook_event.rbi +1552 -0
- data/rbi/orb/models/webhooks/invoice_manually_marked_as_void_standard_webhook_event.rbi +1497 -0
- data/rbi/orb/models/webhooks/invoice_payment_failed_standard_webhook_event.rbi +1557 -0
- data/rbi/orb/models/webhooks/invoice_payment_processing_standard_webhook_event.rbi +1550 -0
- data/rbi/orb/models/webhooks/invoice_payment_succeeded_standard_webhook_event.rbi +1566 -0
- data/rbi/orb/models/webhooks/invoice_sync_failed_standard_webhook_event.rbi +1545 -0
- data/rbi/orb/models/webhooks/invoice_sync_succeeded_standard_webhook_event.rbi +1547 -0
- data/rbi/orb/models/webhooks/invoice_undo_mark_as_paid_standard_webhook_event.rbi +1497 -0
- data/rbi/orb/models/webhooks/metric_events_dropped_by_watermark_standard_webhook_event.rbi +233 -0
- data/rbi/orb/models/webhooks/payment_method_created_standard_webhook_event.rbi +331 -0
- data/rbi/orb/models/webhooks/payment_method_deleted_standard_webhook_event.rbi +331 -0
- data/rbi/orb/models/webhooks/plan_created_standard_webhook_event.rbi +216 -0
- data/rbi/orb/models/webhooks/plan_default_version_set_standard_webhook_event.rbi +277 -0
- data/rbi/orb/models/webhooks/plan_edited_standard_webhook_event.rbi +337 -0
- data/rbi/orb/models/webhooks/plan_version_created_standard_webhook_event.rbi +271 -0
- data/rbi/orb/models/webhooks/price_edited_standard_webhook_event.rbi +311 -0
- data/rbi/orb/models/webhooks/resource_event_test_standard_webhook_event.rbi +191 -0
- data/rbi/orb/models/webhooks/sales_order_accounting_sync_failed_standard_webhook_event.rbi +1708 -0
- data/rbi/orb/models/webhooks/sales_order_accounting_sync_succeeded_standard_webhook_event.rbi +1697 -0
- data/rbi/orb/models/webhooks/standard_unwrap_standard_params.rbi +32 -0
- data/rbi/orb/models/webhooks/subscription_accounting_sync_failed_standard_webhook_event.rbi +609 -0
- data/rbi/orb/models/webhooks/subscription_accounting_sync_succeeded_standard_webhook_event.rbi +598 -0
- data/rbi/orb/models/webhooks/subscription_alert_disabled_standard_webhook_event.rbi +1296 -0
- data/rbi/orb/models/webhooks/subscription_cancellation_scheduled_standard_webhook_event.rbi +433 -0
- data/rbi/orb/models/webhooks/subscription_cancellation_unscheduled_standard_webhook_event.rbi +435 -0
- data/rbi/orb/models/webhooks/subscription_cost_exceeded_standard_webhook_event.rbi +1298 -0
- data/rbi/orb/models/webhooks/subscription_created_standard_webhook_event.rbi +398 -0
- data/rbi/orb/models/webhooks/subscription_edited_standard_webhook_event.rbi +520 -0
- data/rbi/orb/models/webhooks/subscription_ended_standard_webhook_event.rbi +398 -0
- data/rbi/orb/models/webhooks/subscription_fixed_fee_quantity_updated_standard_webhook_event.rbi +458 -0
- data/rbi/orb/models/webhooks/subscription_grouped_cost_exceeded_standard_webhook_event.rbi +1315 -0
- data/rbi/orb/models/webhooks/subscription_invoicing_threshold_exceeded_standard_webhook_event.rbi +422 -0
- data/rbi/orb/models/webhooks/subscription_license_allocation_reset_standard_webhook_event.rbi +471 -0
- data/rbi/orb/models/webhooks/subscription_license_balance_threshold_reached_standard_webhook_event.rbi +1313 -0
- data/rbi/orb/models/webhooks/subscription_plan_change_scheduled_standard_webhook_event.rbi +453 -0
- data/rbi/orb/models/webhooks/subscription_plan_changed_standard_webhook_event.rbi +433 -0
- data/rbi/orb/models/webhooks/subscription_plan_version_change_scheduled_standard_webhook_event.rbi +457 -0
- data/rbi/orb/models/webhooks/subscription_plan_version_changed_standard_webhook_event.rbi +457 -0
- data/rbi/orb/models/webhooks/subscription_spend_exceeded_standard_webhook_event.rbi +1299 -0
- data/rbi/orb/models/webhooks/subscription_started_standard_webhook_event.rbi +398 -0
- data/rbi/orb/models/webhooks/subscription_trial_ended_standard_webhook_event.rbi +398 -0
- data/rbi/orb/models/webhooks/subscription_usage_exceeded_standard_webhook_event.rbi +1305 -0
- data/rbi/orb/models/webhooks/transaction_accounting_sync_failed_standard_webhook_event.rbi +516 -0
- data/rbi/orb/models/webhooks/transaction_accounting_sync_succeeded_standard_webhook_event.rbi +505 -0
- data/rbi/orb/models/webhooks/unwrap_standard_webhook_event.rbi +107 -0
- data/rbi/orb/models.rbi +2 -0
- data/rbi/orb/resources/metrics.rbi +16 -3
- data/rbi/orb/resources/plans/external_plan_id.rbi +6 -2
- data/rbi/orb/resources/plans.rbi +6 -2
- data/rbi/orb/resources/webhook_endpoints.rbi +10 -0
- data/rbi/orb/resources/webhooks/standard.rbi +107 -0
- data/rbi/orb/resources/webhooks.rbi +3 -0
- data/sig/orb/models/metric_list_params.rbs +18 -1
- data/sig/orb/models/metric_update_params.rbs +14 -1
- data/sig/orb/models/plan_update_params.rbs +6 -1
- data/sig/orb/models/plans/external_plan_id_update_params.rbs +6 -1
- data/sig/orb/models/webhook_endpoint.rbs +16 -0
- data/sig/orb/models/webhook_endpoint_create_params.rbs +20 -1
- data/sig/orb/models/webhook_endpoint_update_params.rbs +16 -0
- data/sig/orb/models/webhook_endpoint_with_secret.rbs +16 -0
- data/sig/orb/models/webhooks/backfill_reflected_standard_webhook_event.rbs +148 -0
- data/sig/orb/models/webhooks/backfill_reverted_standard_webhook_event.rbs +148 -0
- data/sig/orb/models/webhooks/billable_metric_edited_standard_webhook_event.rbs +112 -0
- data/sig/orb/models/webhooks/credit_block_accounting_sync_failed_standard_webhook_event.rbs +435 -0
- data/sig/orb/models/webhooks/credit_block_accounting_sync_succeeded_standard_webhook_event.rbs +430 -0
- data/sig/orb/models/webhooks/credit_note_accounting_sync_failed_standard_webhook_event.rbs +165 -0
- data/sig/orb/models/webhooks/credit_note_accounting_sync_succeeded_standard_webhook_event.rbs +160 -0
- data/sig/orb/models/webhooks/credit_note_issued_standard_webhook_event.rbs +68 -0
- data/sig/orb/models/webhooks/credit_note_marked_as_void_standard_webhook_event.rbs +68 -0
- data/sig/orb/models/webhooks/customer_accounting_sync_failed_standard_webhook_event.rbs +160 -0
- data/sig/orb/models/webhooks/customer_accounting_sync_succeeded_standard_webhook_event.rbs +155 -0
- data/sig/orb/models/webhooks/customer_balance_transaction_created_standard_webhook_event.rbs +189 -0
- data/sig/orb/models/webhooks/customer_created_standard_webhook_event.rbs +68 -0
- data/sig/orb/models/webhooks/customer_credit_balance_depleted_standard_webhook_event.rbs +396 -0
- data/sig/orb/models/webhooks/customer_credit_balance_dropped_standard_webhook_event.rbs +401 -0
- data/sig/orb/models/webhooks/customer_credit_balance_recovered_standard_webhook_event.rbs +396 -0
- data/sig/orb/models/webhooks/customer_credit_ledger_incremented_standard_webhook_event.rbs +386 -0
- data/sig/orb/models/webhooks/customer_edited_standard_webhook_event.rbs +157 -0
- data/sig/orb/models/webhooks/data_exports_transfer_error_standard_webhook_event.rbs +110 -0
- data/sig/orb/models/webhooks/data_exports_transfer_success_standard_webhook_event.rbs +105 -0
- data/sig/orb/models/webhooks/event_unmatched_event_standard_webhook_event.rbs +122 -0
- data/sig/orb/models/webhooks/ingestion_unmatched_customer_ids_standard_webhook_event.rbs +73 -0
- data/sig/orb/models/webhooks/invoice_accounting_sync_failed_standard_webhook_event.rbs +614 -0
- data/sig/orb/models/webhooks/invoice_accounting_sync_succeeded_standard_webhook_event.rbs +609 -0
- data/sig/orb/models/webhooks/invoice_automation_schedule_step_executed_standard_webhook_event.rbs +331 -0
- data/sig/orb/models/webhooks/invoice_cost_data_exported_standard_webhook_event.rbs +91 -0
- data/sig/orb/models/webhooks/invoice_due_date_recalculation_canceled_standard_webhook_event.rbs +75 -0
- data/sig/orb/models/webhooks/invoice_due_date_recalculation_completed_standard_webhook_event.rbs +75 -0
- data/sig/orb/models/webhooks/invoice_due_date_recalculation_started_standard_webhook_event.rbs +73 -0
- data/sig/orb/models/webhooks/invoice_dunning_schedule_created_standard_webhook_event.rbs +638 -0
- data/sig/orb/models/webhooks/invoice_dunning_schedule_ended_standard_webhook_event.rbs +633 -0
- data/sig/orb/models/webhooks/invoice_dunning_schedule_reset_standard_webhook_event.rbs +623 -0
- data/sig/orb/models/webhooks/invoice_dunning_schedule_step_executed_standard_webhook_event.rbs +586 -0
- data/sig/orb/models/webhooks/invoice_edited_standard_webhook_event.rbs +859 -0
- data/sig/orb/models/webhooks/invoice_invoice_date_elapsed_standard_webhook_event.rbs +129 -0
- data/sig/orb/models/webhooks/invoice_issue_failed_standard_webhook_event.rbs +527 -0
- data/sig/orb/models/webhooks/invoice_issued_standard_webhook_event.rbs +527 -0
- data/sig/orb/models/webhooks/invoice_issued_summary_standard_webhook_event.rbs +527 -0
- data/sig/orb/models/webhooks/invoice_manually_marked_as_paid_standard_webhook_event.rbs +540 -0
- data/sig/orb/models/webhooks/invoice_manually_marked_as_void_standard_webhook_event.rbs +517 -0
- data/sig/orb/models/webhooks/invoice_payment_failed_standard_webhook_event.rbs +544 -0
- data/sig/orb/models/webhooks/invoice_payment_processing_standard_webhook_event.rbs +538 -0
- data/sig/orb/models/webhooks/invoice_payment_succeeded_standard_webhook_event.rbs +549 -0
- data/sig/orb/models/webhooks/invoice_sync_failed_standard_webhook_event.rbs +536 -0
- data/sig/orb/models/webhooks/invoice_sync_succeeded_standard_webhook_event.rbs +536 -0
- data/sig/orb/models/webhooks/invoice_undo_mark_as_paid_standard_webhook_event.rbs +517 -0
- data/sig/orb/models/webhooks/metric_events_dropped_by_watermark_standard_webhook_event.rbs +100 -0
- data/sig/orb/models/webhooks/payment_method_created_standard_webhook_event.rbs +130 -0
- data/sig/orb/models/webhooks/payment_method_deleted_standard_webhook_event.rbs +130 -0
- data/sig/orb/models/webhooks/plan_created_standard_webhook_event.rbs +90 -0
- data/sig/orb/models/webhooks/plan_default_version_set_standard_webhook_event.rbs +112 -0
- data/sig/orb/models/webhooks/plan_edited_standard_webhook_event.rbs +134 -0
- data/sig/orb/models/webhooks/plan_version_created_standard_webhook_event.rbs +109 -0
- data/sig/orb/models/webhooks/price_edited_standard_webhook_event.rbs +95 -0
- data/sig/orb/models/webhooks/resource_event_test_standard_webhook_event.rbs +75 -0
- data/sig/orb/models/webhooks/sales_order_accounting_sync_failed_standard_webhook_event.rbs +614 -0
- data/sig/orb/models/webhooks/sales_order_accounting_sync_succeeded_standard_webhook_event.rbs +609 -0
- data/sig/orb/models/webhooks/standard_unwrap_standard_params.rbs +17 -0
- data/sig/orb/models/webhooks/subscription_accounting_sync_failed_standard_webhook_event.rbs +256 -0
- data/sig/orb/models/webhooks/subscription_accounting_sync_succeeded_standard_webhook_event.rbs +251 -0
- data/sig/orb/models/webhooks/subscription_alert_disabled_standard_webhook_event.rbs +466 -0
- data/sig/orb/models/webhooks/subscription_cancellation_scheduled_standard_webhook_event.rbs +169 -0
- data/sig/orb/models/webhooks/subscription_cancellation_unscheduled_standard_webhook_event.rbs +169 -0
- data/sig/orb/models/webhooks/subscription_cost_exceeded_standard_webhook_event.rbs +475 -0
- data/sig/orb/models/webhooks/subscription_created_standard_webhook_event.rbs +159 -0
- data/sig/orb/models/webhooks/subscription_edited_standard_webhook_event.rbs +218 -0
- data/sig/orb/models/webhooks/subscription_ended_standard_webhook_event.rbs +159 -0
- data/sig/orb/models/webhooks/subscription_fixed_fee_quantity_updated_standard_webhook_event.rbs +191 -0
- data/sig/orb/models/webhooks/subscription_grouped_cost_exceeded_standard_webhook_event.rbs +487 -0
- data/sig/orb/models/webhooks/subscription_invoicing_threshold_exceeded_standard_webhook_event.rbs +176 -0
- data/sig/orb/models/webhooks/subscription_license_allocation_reset_standard_webhook_event.rbs +198 -0
- data/sig/orb/models/webhooks/subscription_license_balance_threshold_reached_standard_webhook_event.rbs +482 -0
- data/sig/orb/models/webhooks/subscription_plan_change_scheduled_standard_webhook_event.rbs +182 -0
- data/sig/orb/models/webhooks/subscription_plan_changed_standard_webhook_event.rbs +169 -0
- data/sig/orb/models/webhooks/subscription_plan_version_change_scheduled_standard_webhook_event.rbs +186 -0
- data/sig/orb/models/webhooks/subscription_plan_version_changed_standard_webhook_event.rbs +186 -0
- data/sig/orb/models/webhooks/subscription_spend_exceeded_standard_webhook_event.rbs +475 -0
- data/sig/orb/models/webhooks/subscription_started_standard_webhook_event.rbs +159 -0
- data/sig/orb/models/webhooks/subscription_trial_ended_standard_webhook_event.rbs +159 -0
- data/sig/orb/models/webhooks/subscription_usage_exceeded_standard_webhook_event.rbs +480 -0
- data/sig/orb/models/webhooks/transaction_accounting_sync_failed_standard_webhook_event.rbs +223 -0
- data/sig/orb/models/webhooks/transaction_accounting_sync_succeeded_standard_webhook_event.rbs +218 -0
- data/sig/orb/models/webhooks/unwrap_standard_webhook_event.rbs +94 -0
- data/sig/orb/models.rbs +2 -0
- data/sig/orb/resources/metrics.rbs +3 -0
- data/sig/orb/resources/plans/external_plan_id.rbs +1 -0
- data/sig/orb/resources/plans.rbs +1 -0
- data/sig/orb/resources/webhook_endpoints.rbs +2 -0
- data/sig/orb/resources/webhooks/standard.rbs +93 -0
- data/sig/orb/resources/webhooks.rbs +2 -0
- metadata +253 -1
|
@@ -0,0 +1,258 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Orb
|
|
4
|
+
module Models
|
|
5
|
+
module Webhooks
|
|
6
|
+
# Issued when a backfill is closed and its events are reflected into usage.
|
|
7
|
+
module UnwrapStandardWebhookEvent
|
|
8
|
+
extend Orb::Internal::Type::Union
|
|
9
|
+
|
|
10
|
+
# Issued when a backfill is closed and its events are reflected into usage.
|
|
11
|
+
variant -> { Orb::Webhooks::BackfillReflectedStandardWebhookEvent }
|
|
12
|
+
|
|
13
|
+
# Issued when a backfill is reverted, removing its events from usage.
|
|
14
|
+
variant -> { Orb::Webhooks::BackfillRevertedStandardWebhookEvent }
|
|
15
|
+
|
|
16
|
+
# Issued when a billable metric is edited.
|
|
17
|
+
variant -> { Orb::Webhooks::BillableMetricEditedStandardWebhookEvent }
|
|
18
|
+
|
|
19
|
+
# Issued when a credit block accounting sync fails.
|
|
20
|
+
variant -> { Orb::Webhooks::CreditBlockAccountingSyncFailedStandardWebhookEvent }
|
|
21
|
+
|
|
22
|
+
# Issued when a credit block accounting sync succeeds.
|
|
23
|
+
variant -> { Orb::Webhooks::CreditBlockAccountingSyncSucceededStandardWebhookEvent }
|
|
24
|
+
|
|
25
|
+
# Issued when a credit note accounting sync fails.
|
|
26
|
+
variant -> { Orb::Webhooks::CreditNoteAccountingSyncFailedStandardWebhookEvent }
|
|
27
|
+
|
|
28
|
+
# Issued when a credit note accounting sync succeeds.
|
|
29
|
+
variant -> { Orb::Webhooks::CreditNoteAccountingSyncSucceededStandardWebhookEvent }
|
|
30
|
+
|
|
31
|
+
# Issued when a credit note is created.
|
|
32
|
+
variant -> { Orb::Webhooks::CreditNoteIssuedStandardWebhookEvent }
|
|
33
|
+
|
|
34
|
+
# Issued when a credit note is marked as void.
|
|
35
|
+
variant -> { Orb::Webhooks::CreditNoteMarkedAsVoidStandardWebhookEvent }
|
|
36
|
+
|
|
37
|
+
# Issued when a customer accounting sync fails.
|
|
38
|
+
variant -> { Orb::Webhooks::CustomerAccountingSyncFailedStandardWebhookEvent }
|
|
39
|
+
|
|
40
|
+
# Issued when a customer accounting sync succeeds.
|
|
41
|
+
variant -> { Orb::Webhooks::CustomerAccountingSyncSucceededStandardWebhookEvent }
|
|
42
|
+
|
|
43
|
+
# Issued when a customer balance transaction is created.
|
|
44
|
+
variant -> { Orb::Webhooks::CustomerBalanceTransactionCreatedStandardWebhookEvent }
|
|
45
|
+
|
|
46
|
+
# Issued when a customer resource is created.
|
|
47
|
+
variant -> { Orb::Webhooks::CustomerCreatedStandardWebhookEvent }
|
|
48
|
+
|
|
49
|
+
# Issued when a customer's prepaid credits balance is depleted.
|
|
50
|
+
variant -> { Orb::Webhooks::CustomerCreditBalanceDepletedStandardWebhookEvent }
|
|
51
|
+
|
|
52
|
+
# Issued when a customer's prepaid credits balance is depleted to a configured threshold.
|
|
53
|
+
variant -> { Orb::Webhooks::CustomerCreditBalanceDroppedStandardWebhookEvent }
|
|
54
|
+
|
|
55
|
+
# Issued when a customer's credit balance recovers from depleted.
|
|
56
|
+
variant -> { Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent }
|
|
57
|
+
|
|
58
|
+
# Issued when a customer's credit ledger is incremented.
|
|
59
|
+
variant -> { Orb::Webhooks::CustomerCreditLedgerIncrementedStandardWebhookEvent }
|
|
60
|
+
|
|
61
|
+
# Issued when a customer is updated.
|
|
62
|
+
variant -> { Orb::Webhooks::CustomerEditedStandardWebhookEvent }
|
|
63
|
+
|
|
64
|
+
# Issued when a data export transfer fails.
|
|
65
|
+
variant -> { Orb::Webhooks::DataExportsTransferErrorStandardWebhookEvent }
|
|
66
|
+
|
|
67
|
+
# Issued when a data export transfer succeeds.
|
|
68
|
+
variant -> { Orb::Webhooks::DataExportsTransferSuccessStandardWebhookEvent }
|
|
69
|
+
|
|
70
|
+
# Issued when an event does not match any customer.
|
|
71
|
+
variant -> { Orb::Webhooks::EventUnmatchedEventStandardWebhookEvent }
|
|
72
|
+
|
|
73
|
+
# Issued when ingestion events reference unmatched customer IDs.
|
|
74
|
+
variant -> { Orb::Webhooks::IngestionUnmatchedCustomerIDsStandardWebhookEvent }
|
|
75
|
+
|
|
76
|
+
# Issued when an invoice accounting sync fails.
|
|
77
|
+
variant -> { Orb::Webhooks::InvoiceAccountingSyncFailedStandardWebhookEvent }
|
|
78
|
+
|
|
79
|
+
# Issued when an invoice accounting sync succeeds.
|
|
80
|
+
variant -> { Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent }
|
|
81
|
+
|
|
82
|
+
# Issued when a collections-automation schedule step is executed for an invoice.
|
|
83
|
+
variant -> { Orb::Webhooks::InvoiceAutomationScheduleStepExecutedStandardWebhookEvent }
|
|
84
|
+
|
|
85
|
+
# Issued when invoice cost data is exported.
|
|
86
|
+
variant -> { Orb::Webhooks::InvoiceCostDataExportedStandardWebhookEvent }
|
|
87
|
+
|
|
88
|
+
# Issued when a dunning schedule is created for an invoice.
|
|
89
|
+
variant -> { Orb::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent }
|
|
90
|
+
|
|
91
|
+
# Issued when a dunning schedule ends.
|
|
92
|
+
variant -> { Orb::Webhooks::InvoiceDunningScheduleEndedStandardWebhookEvent }
|
|
93
|
+
|
|
94
|
+
# Issued when a dunning schedule is reset.
|
|
95
|
+
variant -> { Orb::Webhooks::InvoiceDunningScheduleResetStandardWebhookEvent }
|
|
96
|
+
|
|
97
|
+
# Issued when a dunning schedule step is executed.
|
|
98
|
+
variant -> { Orb::Webhooks::InvoiceDunningScheduleStepExecutedStandardWebhookEvent }
|
|
99
|
+
|
|
100
|
+
# Issued when a draft invoice has been edited.
|
|
101
|
+
variant -> { Orb::Webhooks::InvoiceEditedStandardWebhookEvent }
|
|
102
|
+
|
|
103
|
+
# Issued when an invoice's invoice date has elapsed.
|
|
104
|
+
variant -> { Orb::Webhooks::InvoiceInvoiceDateElapsedStandardWebhookEvent }
|
|
105
|
+
|
|
106
|
+
# Issued when an invoice issue attempt fails.
|
|
107
|
+
variant -> { Orb::Webhooks::InvoiceIssueFailedStandardWebhookEvent }
|
|
108
|
+
|
|
109
|
+
# Issued when an invoice transitions to the "issued" state.
|
|
110
|
+
variant -> { Orb::Webhooks::InvoiceIssuedStandardWebhookEvent }
|
|
111
|
+
|
|
112
|
+
# A lightweight variant of invoice.issued for accounts configured to receive a summarized invoice payload.
|
|
113
|
+
variant -> { Orb::Webhooks::InvoiceIssuedSummaryStandardWebhookEvent }
|
|
114
|
+
|
|
115
|
+
# Issued when an invoice is manually marked as paid.
|
|
116
|
+
variant -> { Orb::Webhooks::InvoiceManuallyMarkedAsPaidStandardWebhookEvent }
|
|
117
|
+
|
|
118
|
+
# Issued when an invoice is marked as void.
|
|
119
|
+
variant -> { Orb::Webhooks::InvoiceManuallyMarkedAsVoidStandardWebhookEvent }
|
|
120
|
+
|
|
121
|
+
# Issued when automated payment collection for an invoice fails for a configured payment gateway.
|
|
122
|
+
variant -> { Orb::Webhooks::InvoicePaymentFailedStandardWebhookEvent }
|
|
123
|
+
|
|
124
|
+
# Issued when an invoice payment is being processed.
|
|
125
|
+
variant -> { Orb::Webhooks::InvoicePaymentProcessingStandardWebhookEvent }
|
|
126
|
+
|
|
127
|
+
# Issued when automated payment collection for an invoice succeeds for a configured payment gateway.
|
|
128
|
+
variant -> { Orb::Webhooks::InvoicePaymentSucceededStandardWebhookEvent }
|
|
129
|
+
|
|
130
|
+
# Issued when an invoice sync fails.
|
|
131
|
+
variant -> { Orb::Webhooks::InvoiceSyncFailedStandardWebhookEvent }
|
|
132
|
+
|
|
133
|
+
# Issued when an invoice sync succeeds.
|
|
134
|
+
variant -> { Orb::Webhooks::InvoiceSyncSucceededStandardWebhookEvent }
|
|
135
|
+
|
|
136
|
+
# Issued when an invoice is undone from marked as paid.
|
|
137
|
+
variant -> { Orb::Webhooks::InvoiceUndoMarkAsPaidStandardWebhookEvent }
|
|
138
|
+
|
|
139
|
+
# Issued when an invoice due date recalculation is canceled.
|
|
140
|
+
variant -> { Orb::Webhooks::InvoiceDueDateRecalculationCanceledStandardWebhookEvent }
|
|
141
|
+
|
|
142
|
+
# Issued when an invoice due date recalculation is completed.
|
|
143
|
+
variant -> { Orb::Webhooks::InvoiceDueDateRecalculationCompletedStandardWebhookEvent }
|
|
144
|
+
|
|
145
|
+
# Issued when an invoice due date recalculation is started.
|
|
146
|
+
variant -> { Orb::Webhooks::InvoiceDueDateRecalculationStartedStandardWebhookEvent }
|
|
147
|
+
|
|
148
|
+
# Issued when metric events are dropped by watermark threshold.
|
|
149
|
+
variant -> { Orb::Webhooks::MetricEventsDroppedByWatermarkStandardWebhookEvent }
|
|
150
|
+
|
|
151
|
+
# Issued when a payment method is created.
|
|
152
|
+
variant -> { Orb::Webhooks::PaymentMethodCreatedStandardWebhookEvent }
|
|
153
|
+
|
|
154
|
+
# Issued when a payment method is deleted.
|
|
155
|
+
variant -> { Orb::Webhooks::PaymentMethodDeletedStandardWebhookEvent }
|
|
156
|
+
|
|
157
|
+
# Issued when a plan is created, or when a draft plan is published.
|
|
158
|
+
variant -> { Orb::Webhooks::PlanCreatedStandardWebhookEvent }
|
|
159
|
+
|
|
160
|
+
# Issued when a plan's default version is set.
|
|
161
|
+
variant -> { Orb::Webhooks::PlanDefaultVersionSetStandardWebhookEvent }
|
|
162
|
+
|
|
163
|
+
# Issued when a plan's name, description, external plan ID, metadata or status is edited.
|
|
164
|
+
variant -> { Orb::Webhooks::PlanEditedStandardWebhookEvent }
|
|
165
|
+
|
|
166
|
+
# Issued when a new plan version is created.
|
|
167
|
+
variant -> { Orb::Webhooks::PlanVersionCreatedStandardWebhookEvent }
|
|
168
|
+
|
|
169
|
+
# Issued when a price is edited.
|
|
170
|
+
variant -> { Orb::Webhooks::PriceEditedStandardWebhookEvent }
|
|
171
|
+
|
|
172
|
+
# Issued when a test webhook is sent.
|
|
173
|
+
variant -> { Orb::Webhooks::ResourceEventTestStandardWebhookEvent }
|
|
174
|
+
|
|
175
|
+
# Issued when a sales order accounting sync fails.
|
|
176
|
+
variant -> { Orb::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent }
|
|
177
|
+
|
|
178
|
+
# Issued when a sales order accounting sync succeeds.
|
|
179
|
+
variant -> { Orb::Webhooks::SalesOrderAccountingSyncSucceededStandardWebhookEvent }
|
|
180
|
+
|
|
181
|
+
# Issued when a subscription accounting sync fails.
|
|
182
|
+
variant -> { Orb::Webhooks::SubscriptionAccountingSyncFailedStandardWebhookEvent }
|
|
183
|
+
|
|
184
|
+
# Issued when a subscription accounting sync succeeds.
|
|
185
|
+
variant -> { Orb::Webhooks::SubscriptionAccountingSyncSucceededStandardWebhookEvent }
|
|
186
|
+
|
|
187
|
+
# Issued when an alert is automatically disabled by the system.
|
|
188
|
+
variant -> { Orb::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent }
|
|
189
|
+
|
|
190
|
+
# Issued when a subscription cancellation is scheduled.
|
|
191
|
+
variant -> { Orb::Webhooks::SubscriptionCancellationScheduledStandardWebhookEvent }
|
|
192
|
+
|
|
193
|
+
# Issued when a scheduled subscription cancellation is unscheduled.
|
|
194
|
+
variant -> { Orb::Webhooks::SubscriptionCancellationUnscheduledStandardWebhookEvent }
|
|
195
|
+
|
|
196
|
+
# Issued when a subscription's cost exceeds a pre-configured amount threshold.
|
|
197
|
+
variant -> { Orb::Webhooks::SubscriptionCostExceededStandardWebhookEvent }
|
|
198
|
+
|
|
199
|
+
# Issued when a subscription resource is created.
|
|
200
|
+
variant -> { Orb::Webhooks::SubscriptionCreatedStandardWebhookEvent }
|
|
201
|
+
|
|
202
|
+
# Issued when a subscription is updated.
|
|
203
|
+
variant -> { Orb::Webhooks::SubscriptionEditedStandardWebhookEvent }
|
|
204
|
+
|
|
205
|
+
# Issued whenever a customer's subscription ends/lapses.
|
|
206
|
+
variant -> { Orb::Webhooks::SubscriptionEndedStandardWebhookEvent }
|
|
207
|
+
|
|
208
|
+
# Issued when a subscription's fixed fee quantity is updated.
|
|
209
|
+
variant -> { Orb::Webhooks::SubscriptionFixedFeeQuantityUpdatedStandardWebhookEvent }
|
|
210
|
+
|
|
211
|
+
# Issued when grouped subscription costs exceed a pre-configured amount threshold.
|
|
212
|
+
variant -> { Orb::Webhooks::SubscriptionGroupedCostExceededStandardWebhookEvent }
|
|
213
|
+
|
|
214
|
+
# Issued when a subscription's invoicing threshold is exceeded and an evaluation is performed.
|
|
215
|
+
variant -> { Orb::Webhooks::SubscriptionInvoicingThresholdExceededStandardWebhookEvent }
|
|
216
|
+
|
|
217
|
+
# Issued when a license allocation is reset.
|
|
218
|
+
variant -> { Orb::Webhooks::SubscriptionLicenseAllocationResetStandardWebhookEvent }
|
|
219
|
+
|
|
220
|
+
# Issued when a license balance threshold is reached.
|
|
221
|
+
variant -> { Orb::Webhooks::SubscriptionLicenseBalanceThresholdReachedStandardWebhookEvent }
|
|
222
|
+
|
|
223
|
+
# Issued when a subscription plan change is scheduled.
|
|
224
|
+
variant -> { Orb::Webhooks::SubscriptionPlanChangeScheduledStandardWebhookEvent }
|
|
225
|
+
|
|
226
|
+
# Issued when a subscription transitions from one plan to a different plan.
|
|
227
|
+
variant -> { Orb::Webhooks::SubscriptionPlanChangedStandardWebhookEvent }
|
|
228
|
+
|
|
229
|
+
# Issued when a subscription plan version change is scheduled.
|
|
230
|
+
variant -> { Orb::Webhooks::SubscriptionPlanVersionChangeScheduledStandardWebhookEvent }
|
|
231
|
+
|
|
232
|
+
# Issued when a subscription plan version has changed.
|
|
233
|
+
variant -> { Orb::Webhooks::SubscriptionPlanVersionChangedStandardWebhookEvent }
|
|
234
|
+
|
|
235
|
+
# Issued when a subscription's rated spend, before credits and adjustments, exceeds a pre-configured amount threshold.
|
|
236
|
+
variant -> { Orb::Webhooks::SubscriptionSpendExceededStandardWebhookEvent }
|
|
237
|
+
|
|
238
|
+
# Issued when a subscription begins.
|
|
239
|
+
variant -> { Orb::Webhooks::SubscriptionStartedStandardWebhookEvent }
|
|
240
|
+
|
|
241
|
+
# Issued when a subscription trial ends.
|
|
242
|
+
variant -> { Orb::Webhooks::SubscriptionTrialEndedStandardWebhookEvent }
|
|
243
|
+
|
|
244
|
+
# Issued when a billable metric in a subscription exceeds a pre-configured quantity threshold.
|
|
245
|
+
variant -> { Orb::Webhooks::SubscriptionUsageExceededStandardWebhookEvent }
|
|
246
|
+
|
|
247
|
+
# Issued when a transaction accounting sync fails.
|
|
248
|
+
variant -> { Orb::Webhooks::TransactionAccountingSyncFailedStandardWebhookEvent }
|
|
249
|
+
|
|
250
|
+
# Issued when a transaction accounting sync succeeds.
|
|
251
|
+
variant -> { Orb::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent }
|
|
252
|
+
|
|
253
|
+
# @!method self.variants
|
|
254
|
+
# @return [Array(Orb::Models::Webhooks::BackfillReflectedStandardWebhookEvent, Orb::Models::Webhooks::BackfillRevertedStandardWebhookEvent, Orb::Models::Webhooks::BillableMetricEditedStandardWebhookEvent, Orb::Models::Webhooks::CreditBlockAccountingSyncFailedStandardWebhookEvent, Orb::Models::Webhooks::CreditBlockAccountingSyncSucceededStandardWebhookEvent, Orb::Models::Webhooks::CreditNoteAccountingSyncFailedStandardWebhookEvent, Orb::Models::Webhooks::CreditNoteAccountingSyncSucceededStandardWebhookEvent, Orb::Models::Webhooks::CreditNoteIssuedStandardWebhookEvent, Orb::Models::Webhooks::CreditNoteMarkedAsVoidStandardWebhookEvent, Orb::Models::Webhooks::CustomerAccountingSyncFailedStandardWebhookEvent, Orb::Models::Webhooks::CustomerAccountingSyncSucceededStandardWebhookEvent, Orb::Models::Webhooks::CustomerBalanceTransactionCreatedStandardWebhookEvent, Orb::Models::Webhooks::CustomerCreatedStandardWebhookEvent, Orb::Models::Webhooks::CustomerCreditBalanceDepletedStandardWebhookEvent, Orb::Models::Webhooks::CustomerCreditBalanceDroppedStandardWebhookEvent, Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent, Orb::Models::Webhooks::CustomerCreditLedgerIncrementedStandardWebhookEvent, Orb::Models::Webhooks::CustomerEditedStandardWebhookEvent, Orb::Models::Webhooks::DataExportsTransferErrorStandardWebhookEvent, Orb::Models::Webhooks::DataExportsTransferSuccessStandardWebhookEvent, Orb::Models::Webhooks::EventUnmatchedEventStandardWebhookEvent, Orb::Models::Webhooks::IngestionUnmatchedCustomerIDsStandardWebhookEvent, Orb::Models::Webhooks::InvoiceAccountingSyncFailedStandardWebhookEvent, Orb::Models::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent, Orb::Models::Webhooks::InvoiceAutomationScheduleStepExecutedStandardWebhookEvent, Orb::Models::Webhooks::InvoiceCostDataExportedStandardWebhookEvent, Orb::Models::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent, Orb::Models::Webhooks::InvoiceDunningScheduleEndedStandardWebhookEvent, Orb::Models::Webhooks::InvoiceDunningScheduleResetStandardWebhookEvent, Orb::Models::Webhooks::InvoiceDunningScheduleStepExecutedStandardWebhookEvent, Orb::Models::Webhooks::InvoiceEditedStandardWebhookEvent, Orb::Models::Webhooks::InvoiceInvoiceDateElapsedStandardWebhookEvent, Orb::Models::Webhooks::InvoiceIssueFailedStandardWebhookEvent, Orb::Models::Webhooks::InvoiceIssuedStandardWebhookEvent, Orb::Models::Webhooks::InvoiceIssuedSummaryStandardWebhookEvent, Orb::Models::Webhooks::InvoiceManuallyMarkedAsPaidStandardWebhookEvent, Orb::Models::Webhooks::InvoiceManuallyMarkedAsVoidStandardWebhookEvent, Orb::Models::Webhooks::InvoicePaymentFailedStandardWebhookEvent, Orb::Models::Webhooks::InvoicePaymentProcessingStandardWebhookEvent, Orb::Models::Webhooks::InvoicePaymentSucceededStandardWebhookEvent, Orb::Models::Webhooks::InvoiceSyncFailedStandardWebhookEvent, Orb::Models::Webhooks::InvoiceSyncSucceededStandardWebhookEvent, Orb::Models::Webhooks::InvoiceUndoMarkAsPaidStandardWebhookEvent, Orb::Models::Webhooks::InvoiceDueDateRecalculationCanceledStandardWebhookEvent, Orb::Models::Webhooks::InvoiceDueDateRecalculationCompletedStandardWebhookEvent, Orb::Models::Webhooks::InvoiceDueDateRecalculationStartedStandardWebhookEvent, Orb::Models::Webhooks::MetricEventsDroppedByWatermarkStandardWebhookEvent, Orb::Models::Webhooks::PaymentMethodCreatedStandardWebhookEvent, Orb::Models::Webhooks::PaymentMethodDeletedStandardWebhookEvent, Orb::Models::Webhooks::PlanCreatedStandardWebhookEvent, Orb::Models::Webhooks::PlanDefaultVersionSetStandardWebhookEvent, Orb::Models::Webhooks::PlanEditedStandardWebhookEvent, Orb::Models::Webhooks::PlanVersionCreatedStandardWebhookEvent, Orb::Models::Webhooks::PriceEditedStandardWebhookEvent, Orb::Models::Webhooks::ResourceEventTestStandardWebhookEvent, Orb::Models::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent, Orb::Models::Webhooks::SalesOrderAccountingSyncSucceededStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionAccountingSyncFailedStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionAccountingSyncSucceededStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionCancellationScheduledStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionCancellationUnscheduledStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionCostExceededStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionCreatedStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionEditedStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionEndedStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionFixedFeeQuantityUpdatedStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionGroupedCostExceededStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionInvoicingThresholdExceededStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionLicenseAllocationResetStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionLicenseBalanceThresholdReachedStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionPlanChangeScheduledStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionPlanChangedStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionPlanVersionChangeScheduledStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionPlanVersionChangedStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionSpendExceededStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionStartedStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionTrialEndedStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionUsageExceededStandardWebhookEvent, Orb::Models::Webhooks::TransactionAccountingSyncFailedStandardWebhookEvent, Orb::Models::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent)]
|
|
255
|
+
end
|
|
256
|
+
end
|
|
257
|
+
end
|
|
258
|
+
end
|
data/lib/orb/models.rb
CHANGED
|
@@ -44,16 +44,21 @@ module Orb
|
|
|
44
44
|
# Some parameter documentations has been truncated, see
|
|
45
45
|
# {Orb::Models::MetricUpdateParams} for more details.
|
|
46
46
|
#
|
|
47
|
-
# This endpoint allows you to update the `
|
|
48
|
-
#
|
|
49
|
-
#
|
|
47
|
+
# This endpoint allows you to update the `name`, `description`, and `metadata`
|
|
48
|
+
# properties on a metric. Fields left out of the request are not changed, and
|
|
49
|
+
# `name` cannot be empty. If you pass `null` for the metadata value, it will clear
|
|
50
|
+
# any existing metadata for that metric.
|
|
50
51
|
#
|
|
51
|
-
# @overload update(metric_id, metadata: nil, request_options: {})
|
|
52
|
+
# @overload update(metric_id, description: nil, metadata: nil, name: nil, request_options: {})
|
|
52
53
|
#
|
|
53
54
|
# @param metric_id [String]
|
|
54
55
|
#
|
|
56
|
+
# @param description [String, nil] A description of the metric.
|
|
57
|
+
#
|
|
55
58
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
|
56
59
|
#
|
|
60
|
+
# @param name [String, nil] The name of the metric.
|
|
61
|
+
#
|
|
57
62
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
58
63
|
#
|
|
59
64
|
# @return [Orb::Models::BillableMetric]
|
|
@@ -76,7 +81,10 @@ module Orb
|
|
|
76
81
|
# This endpoint is used to list [metrics](/core-concepts#metric). It returns
|
|
77
82
|
# information about the metrics including its name, description, and item.
|
|
78
83
|
#
|
|
79
|
-
#
|
|
84
|
+
# Pass `status` to only return metrics with that status, e.g. `status=active` to
|
|
85
|
+
# leave out archived metrics.
|
|
86
|
+
#
|
|
87
|
+
# @overload list(created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, cursor: nil, limit: nil, status: nil, request_options: {})
|
|
80
88
|
#
|
|
81
89
|
# @param created_at_gt [Time, nil]
|
|
82
90
|
#
|
|
@@ -90,6 +98,8 @@ module Orb
|
|
|
90
98
|
#
|
|
91
99
|
# @param limit [Integer] The number of items to fetch. Defaults to 20.
|
|
92
100
|
#
|
|
101
|
+
# @param status [Symbol, Orb::Models::MetricListParams::Status, nil] The metric status to filter to ('active', 'archived', or 'draft').
|
|
102
|
+
#
|
|
93
103
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
94
104
|
#
|
|
95
105
|
# @return [Orb::Internal::Page<Orb::Models::BillableMetric>]
|
|
@@ -11,12 +11,13 @@ module Orb
|
|
|
11
11
|
# Some parameter documentations has been truncated, see
|
|
12
12
|
# {Orb::Models::Plans::ExternalPlanIDUpdateParams} for more details.
|
|
13
13
|
#
|
|
14
|
-
# This endpoint can be used to update the `
|
|
15
|
-
# `metadata` of an existing plan.
|
|
14
|
+
# This endpoint can be used to update the `name`, `external_plan_id`,
|
|
15
|
+
# `description`, and `metadata` of an existing plan. A plan's `name` cannot be
|
|
16
|
+
# empty.
|
|
16
17
|
#
|
|
17
18
|
# Other fields on a plan are currently immutable.
|
|
18
19
|
#
|
|
19
|
-
# @overload update(other_external_plan_id, description: nil, external_plan_id: nil, metadata: nil, request_options: {})
|
|
20
|
+
# @overload update(other_external_plan_id, description: nil, external_plan_id: nil, metadata: nil, name: nil, request_options: {})
|
|
20
21
|
#
|
|
21
22
|
# @param other_external_plan_id [String]
|
|
22
23
|
#
|
|
@@ -26,6 +27,8 @@ module Orb
|
|
|
26
27
|
#
|
|
27
28
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
|
28
29
|
#
|
|
30
|
+
# @param name [String, nil] The name of the plan.
|
|
31
|
+
#
|
|
29
32
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
30
33
|
#
|
|
31
34
|
# @return [Orb::Models::Plan]
|
data/lib/orb/resources/plans.rb
CHANGED
|
@@ -63,12 +63,13 @@ module Orb
|
|
|
63
63
|
# Some parameter documentations has been truncated, see
|
|
64
64
|
# {Orb::Models::PlanUpdateParams} for more details.
|
|
65
65
|
#
|
|
66
|
-
# This endpoint can be used to update the `
|
|
67
|
-
# `metadata` of an existing plan.
|
|
66
|
+
# This endpoint can be used to update the `name`, `external_plan_id`,
|
|
67
|
+
# `description`, and `metadata` of an existing plan. A plan's `name` cannot be
|
|
68
|
+
# empty.
|
|
68
69
|
#
|
|
69
70
|
# Other fields on a plan are currently immutable.
|
|
70
71
|
#
|
|
71
|
-
# @overload update(plan_id, description: nil, external_plan_id: nil, metadata: nil, request_options: {})
|
|
72
|
+
# @overload update(plan_id, description: nil, external_plan_id: nil, metadata: nil, name: nil, request_options: {})
|
|
72
73
|
#
|
|
73
74
|
# @param plan_id [String]
|
|
74
75
|
#
|
|
@@ -78,6 +79,8 @@ module Orb
|
|
|
78
79
|
#
|
|
79
80
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
|
80
81
|
#
|
|
82
|
+
# @param name [String, nil] The name of the plan.
|
|
83
|
+
#
|
|
81
84
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
82
85
|
#
|
|
83
86
|
# @return [Orb::Models::Plan]
|
|
@@ -12,12 +12,14 @@ module Orb
|
|
|
12
12
|
# webhook events. The secret isn't returned by any other endpoint. An account can
|
|
13
13
|
# have at most 20 webhook endpoints by default.
|
|
14
14
|
#
|
|
15
|
-
# @overload create(url:, enabled_event_types: nil, request_options: {})
|
|
15
|
+
# @overload create(url:, enabled_event_types: nil, payload_style: nil, request_options: {})
|
|
16
16
|
#
|
|
17
17
|
# @param url [String] The HTTPS URL that Orb sends webhook events to.
|
|
18
18
|
#
|
|
19
19
|
# @param enabled_event_types [Array<String>, nil] The webhook event types to send to this endpoint. If omitted or null, all event
|
|
20
20
|
#
|
|
21
|
+
# @param payload_style [Symbol, Orb::Models::WebhookEndpointCreateParams::PayloadStyle, nil] The payload style of the webhook events sent to this endpoint. If omitted or nul
|
|
22
|
+
#
|
|
21
23
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
22
24
|
#
|
|
23
25
|
# @return [Orb::Models::WebhookEndpointWithSecret]
|
|
@@ -58,12 +60,14 @@ module Orb
|
|
|
58
60
|
#
|
|
59
61
|
# This endpoint updates a webhook endpoint's URL or the event types sent to it.
|
|
60
62
|
#
|
|
61
|
-
# @overload update(webhook_endpoint_id, enabled_event_types: nil, url: nil, request_options: {})
|
|
63
|
+
# @overload update(webhook_endpoint_id, enabled_event_types: nil, payload_style: nil, url: nil, request_options: {})
|
|
62
64
|
#
|
|
63
65
|
# @param webhook_endpoint_id [String]
|
|
64
66
|
#
|
|
65
67
|
# @param enabled_event_types [Array<String>, nil] The webhook event types to send to this endpoint. Null sends all event types; om
|
|
66
68
|
#
|
|
69
|
+
# @param payload_style [Symbol, Orb::Models::WebhookEndpointUpdateParams::PayloadStyle, nil] The payload style of the webhook events sent to this endpoint. Applies to events
|
|
70
|
+
#
|
|
67
71
|
# @param url [String, nil] The HTTPS URL that Orb sends webhook events to.
|
|
68
72
|
#
|
|
69
73
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Orb
|
|
4
|
+
module Resources
|
|
5
|
+
class Webhooks
|
|
6
|
+
class Standard
|
|
7
|
+
# @param payload [String] The raw webhook payload as a string
|
|
8
|
+
#
|
|
9
|
+
# @return [Orb::Models::Webhooks::BackfillReflectedStandardWebhookEvent, Orb::Models::Webhooks::BackfillRevertedStandardWebhookEvent, Orb::Models::Webhooks::BillableMetricEditedStandardWebhookEvent, Orb::Models::Webhooks::CreditBlockAccountingSyncFailedStandardWebhookEvent, Orb::Models::Webhooks::CreditBlockAccountingSyncSucceededStandardWebhookEvent, Orb::Models::Webhooks::CreditNoteAccountingSyncFailedStandardWebhookEvent, Orb::Models::Webhooks::CreditNoteAccountingSyncSucceededStandardWebhookEvent, Orb::Models::Webhooks::CreditNoteIssuedStandardWebhookEvent, Orb::Models::Webhooks::CreditNoteMarkedAsVoidStandardWebhookEvent, Orb::Models::Webhooks::CustomerAccountingSyncFailedStandardWebhookEvent, Orb::Models::Webhooks::CustomerAccountingSyncSucceededStandardWebhookEvent, Orb::Models::Webhooks::CustomerBalanceTransactionCreatedStandardWebhookEvent, Orb::Models::Webhooks::CustomerCreatedStandardWebhookEvent, Orb::Models::Webhooks::CustomerCreditBalanceDepletedStandardWebhookEvent, Orb::Models::Webhooks::CustomerCreditBalanceDroppedStandardWebhookEvent, Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent, Orb::Models::Webhooks::CustomerCreditLedgerIncrementedStandardWebhookEvent, Orb::Models::Webhooks::CustomerEditedStandardWebhookEvent, Orb::Models::Webhooks::DataExportsTransferErrorStandardWebhookEvent, Orb::Models::Webhooks::DataExportsTransferSuccessStandardWebhookEvent, Orb::Models::Webhooks::EventUnmatchedEventStandardWebhookEvent, Orb::Models::Webhooks::IngestionUnmatchedCustomerIDsStandardWebhookEvent, Orb::Models::Webhooks::InvoiceAccountingSyncFailedStandardWebhookEvent, Orb::Models::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent, Orb::Models::Webhooks::InvoiceAutomationScheduleStepExecutedStandardWebhookEvent, Orb::Models::Webhooks::InvoiceCostDataExportedStandardWebhookEvent, Orb::Models::Webhooks::InvoiceDunningScheduleCreatedStandardWebhookEvent, Orb::Models::Webhooks::InvoiceDunningScheduleEndedStandardWebhookEvent, Orb::Models::Webhooks::InvoiceDunningScheduleResetStandardWebhookEvent, Orb::Models::Webhooks::InvoiceDunningScheduleStepExecutedStandardWebhookEvent, Orb::Models::Webhooks::InvoiceEditedStandardWebhookEvent, Orb::Models::Webhooks::InvoiceInvoiceDateElapsedStandardWebhookEvent, Orb::Models::Webhooks::InvoiceIssueFailedStandardWebhookEvent, Orb::Models::Webhooks::InvoiceIssuedStandardWebhookEvent, Orb::Models::Webhooks::InvoiceIssuedSummaryStandardWebhookEvent, Orb::Models::Webhooks::InvoiceManuallyMarkedAsPaidStandardWebhookEvent, Orb::Models::Webhooks::InvoiceManuallyMarkedAsVoidStandardWebhookEvent, Orb::Models::Webhooks::InvoicePaymentFailedStandardWebhookEvent, Orb::Models::Webhooks::InvoicePaymentProcessingStandardWebhookEvent, Orb::Models::Webhooks::InvoicePaymentSucceededStandardWebhookEvent, Orb::Models::Webhooks::InvoiceSyncFailedStandardWebhookEvent, Orb::Models::Webhooks::InvoiceSyncSucceededStandardWebhookEvent, Orb::Models::Webhooks::InvoiceUndoMarkAsPaidStandardWebhookEvent, Orb::Models::Webhooks::InvoiceDueDateRecalculationCanceledStandardWebhookEvent, Orb::Models::Webhooks::InvoiceDueDateRecalculationCompletedStandardWebhookEvent, Orb::Models::Webhooks::InvoiceDueDateRecalculationStartedStandardWebhookEvent, Orb::Models::Webhooks::MetricEventsDroppedByWatermarkStandardWebhookEvent, Orb::Models::Webhooks::PaymentMethodCreatedStandardWebhookEvent, Orb::Models::Webhooks::PaymentMethodDeletedStandardWebhookEvent, Orb::Models::Webhooks::PlanCreatedStandardWebhookEvent, Orb::Models::Webhooks::PlanDefaultVersionSetStandardWebhookEvent, Orb::Models::Webhooks::PlanEditedStandardWebhookEvent, Orb::Models::Webhooks::PlanVersionCreatedStandardWebhookEvent, Orb::Models::Webhooks::PriceEditedStandardWebhookEvent, Orb::Models::Webhooks::ResourceEventTestStandardWebhookEvent, Orb::Models::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent, Orb::Models::Webhooks::SalesOrderAccountingSyncSucceededStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionAccountingSyncFailedStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionAccountingSyncSucceededStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionCancellationScheduledStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionCancellationUnscheduledStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionCostExceededStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionCreatedStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionEditedStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionEndedStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionFixedFeeQuantityUpdatedStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionGroupedCostExceededStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionInvoicingThresholdExceededStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionLicenseAllocationResetStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionLicenseBalanceThresholdReachedStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionPlanChangeScheduledStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionPlanChangedStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionPlanVersionChangeScheduledStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionPlanVersionChangedStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionSpendExceededStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionStartedStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionTrialEndedStandardWebhookEvent, Orb::Models::Webhooks::SubscriptionUsageExceededStandardWebhookEvent, Orb::Models::Webhooks::TransactionAccountingSyncFailedStandardWebhookEvent, Orb::Models::Webhooks::TransactionAccountingSyncSucceededStandardWebhookEvent]
|
|
10
|
+
def unwrap_standard(payload)
|
|
11
|
+
parsed = JSON.parse(payload, symbolize_names: true)
|
|
12
|
+
Orb::Internal::Type::Converter.coerce(Orb::Models::Webhooks::UnwrapStandardWebhookEvent, parsed)
|
|
13
|
+
end
|
|
14
|
+
|
|
15
|
+
# @api private
|
|
16
|
+
#
|
|
17
|
+
# @param client [Orb::Client]
|
|
18
|
+
def initialize(client:)
|
|
19
|
+
@client = client
|
|
20
|
+
end
|
|
21
|
+
end
|
|
22
|
+
end
|
|
23
|
+
end
|
|
24
|
+
end
|
|
@@ -3,6 +3,9 @@
|
|
|
3
3
|
module Orb
|
|
4
4
|
module Resources
|
|
5
5
|
class Webhooks
|
|
6
|
+
# @return [Orb::Resources::Webhooks::Standard]
|
|
7
|
+
attr_reader :standard
|
|
8
|
+
|
|
6
9
|
# @param payload [String] The raw webhook payload as a string
|
|
7
10
|
#
|
|
8
11
|
# @return [Orb::Models::BackfillReflectedWebhookEvent, Orb::Models::BackfillRevertedWebhookEvent, Orb::Models::BillableMetricEditedWebhookEvent, Orb::Models::CreditBlockAccountingSyncFailedWebhookEvent, Orb::Models::CreditBlockAccountingSyncSucceededWebhookEvent, Orb::Models::CreditNoteAccountingSyncFailedWebhookEvent, Orb::Models::CreditNoteAccountingSyncSucceededWebhookEvent, Orb::Models::CreditNoteIssuedWebhookEvent, Orb::Models::CreditNoteMarkedAsVoidWebhookEvent, Orb::Models::CustomerAccountingSyncFailedWebhookEvent, Orb::Models::CustomerAccountingSyncSucceededWebhookEvent, Orb::Models::CustomerBalanceTransactionCreatedWebhookEvent, Orb::Models::CustomerCreatedWebhookEvent, Orb::Models::CustomerCreditBalanceDepletedWebhookEvent, Orb::Models::CustomerCreditBalanceDroppedWebhookEvent, Orb::Models::CustomerCreditBalanceRecoveredWebhookEvent, Orb::Models::CustomerCreditLedgerIncrementedWebhookEvent, Orb::Models::CustomerEditedWebhookEvent, Orb::Models::DataExportsTransferErrorWebhookEvent, Orb::Models::DataExportsTransferSuccessWebhookEvent, Orb::Models::EventUnmatchedEventWebhookEvent, Orb::Models::IngestionUnmatchedCustomerIDsWebhookEvent, Orb::Models::InvoiceAccountingSyncFailedWebhookEvent, Orb::Models::InvoiceAccountingSyncSucceededWebhookEvent, Orb::Models::InvoiceAutomationScheduleStepExecutedWebhookEvent, Orb::Models::InvoiceCostDataExportedWebhookEvent, Orb::Models::InvoiceDunningScheduleCreatedWebhookEvent, Orb::Models::InvoiceDunningScheduleEndedWebhookEvent, Orb::Models::InvoiceDunningScheduleResetWebhookEvent, Orb::Models::InvoiceDunningScheduleStepExecutedWebhookEvent, Orb::Models::InvoiceEditedWebhookEvent, Orb::Models::InvoiceInvoiceDateElapsedWebhookEvent, Orb::Models::InvoiceIssueFailedWebhookEvent, Orb::Models::InvoiceIssuedWebhookEvent, Orb::Models::InvoiceIssuedSummaryWebhookEvent, Orb::Models::InvoiceManuallyMarkedAsPaidWebhookEvent, Orb::Models::InvoiceManuallyMarkedAsVoidWebhookEvent, Orb::Models::InvoicePaymentFailedWebhookEvent, Orb::Models::InvoicePaymentProcessingWebhookEvent, Orb::Models::InvoicePaymentSucceededWebhookEvent, Orb::Models::InvoiceSyncFailedWebhookEvent, Orb::Models::InvoiceSyncSucceededWebhookEvent, Orb::Models::InvoiceUndoMarkAsPaidWebhookEvent, Orb::Models::InvoiceDueDateRecalculationCanceledWebhookEvent, Orb::Models::InvoiceDueDateRecalculationCompletedWebhookEvent, Orb::Models::InvoiceDueDateRecalculationStartedWebhookEvent, Orb::Models::MetricEventsDroppedByWatermarkWebhookEvent, Orb::Models::PaymentMethodCreatedWebhookEvent, Orb::Models::PaymentMethodDeletedWebhookEvent, Orb::Models::PlanCreatedWebhookEvent, Orb::Models::PlanDefaultVersionSetWebhookEvent, Orb::Models::PlanEditedWebhookEvent, Orb::Models::PlanVersionCreatedWebhookEvent, Orb::Models::PriceEditedWebhookEvent, Orb::Models::ResourceEventTestWebhookEvent, Orb::Models::SalesOrderAccountingSyncFailedWebhookEvent, Orb::Models::SalesOrderAccountingSyncSucceededWebhookEvent, Orb::Models::SubscriptionAccountingSyncFailedWebhookEvent, Orb::Models::SubscriptionAccountingSyncSucceededWebhookEvent, Orb::Models::SubscriptionAlertDisabledWebhookEvent, Orb::Models::SubscriptionCancellationScheduledWebhookEvent, Orb::Models::SubscriptionCancellationUnscheduledWebhookEvent, Orb::Models::SubscriptionCostExceededWebhookEvent, Orb::Models::SubscriptionCreatedWebhookEvent, Orb::Models::SubscriptionEditedWebhookEvent, Orb::Models::SubscriptionEndedWebhookEvent, Orb::Models::SubscriptionFixedFeeQuantityUpdatedWebhookEvent, Orb::Models::SubscriptionGroupedCostExceededWebhookEvent, Orb::Models::SubscriptionInvoicingThresholdExceededWebhookEvent, Orb::Models::SubscriptionLicenseAllocationResetWebhookEvent, Orb::Models::SubscriptionLicenseBalanceThresholdReachedWebhookEvent, Orb::Models::SubscriptionPlanChangeScheduledWebhookEvent, Orb::Models::SubscriptionPlanChangedWebhookEvent, Orb::Models::SubscriptionPlanVersionChangeScheduledWebhookEvent, Orb::Models::SubscriptionPlanVersionChangedWebhookEvent, Orb::Models::SubscriptionSpendExceededWebhookEvent, Orb::Models::SubscriptionStartedWebhookEvent, Orb::Models::SubscriptionTrialEndedWebhookEvent, Orb::Models::SubscriptionUsageExceededWebhookEvent, Orb::Models::TransactionAccountingSyncFailedWebhookEvent, Orb::Models::TransactionAccountingSyncSucceededWebhookEvent]
|
|
@@ -16,6 +19,7 @@ module Orb
|
|
|
16
19
|
# @param client [Orb::Client]
|
|
17
20
|
def initialize(client:)
|
|
18
21
|
@client = client
|
|
22
|
+
@standard = Orb::Resources::Webhooks::Standard.new(client: client)
|
|
19
23
|
end
|
|
20
24
|
end
|
|
21
25
|
end
|
data/lib/orb/version.rb
CHANGED
data/lib/orb.rb
CHANGED
|
@@ -538,6 +538,89 @@ require_relative "orb/models/webhook_endpoint_list_params"
|
|
|
538
538
|
require_relative "orb/models/webhook_endpoint_retrieve_params"
|
|
539
539
|
require_relative "orb/models/webhook_endpoint_update_params"
|
|
540
540
|
require_relative "orb/models/webhook_endpoint_with_secret"
|
|
541
|
+
require_relative "orb/models/webhooks/backfill_reflected_standard_webhook_event"
|
|
542
|
+
require_relative "orb/models/webhooks/backfill_reverted_standard_webhook_event"
|
|
543
|
+
require_relative "orb/models/webhooks/billable_metric_edited_standard_webhook_event"
|
|
544
|
+
require_relative "orb/models/webhooks/credit_block_accounting_sync_failed_standard_webhook_event"
|
|
545
|
+
require_relative "orb/models/webhooks/credit_block_accounting_sync_succeeded_standard_webhook_event"
|
|
546
|
+
require_relative "orb/models/webhooks/credit_note_accounting_sync_failed_standard_webhook_event"
|
|
547
|
+
require_relative "orb/models/webhooks/credit_note_accounting_sync_succeeded_standard_webhook_event"
|
|
548
|
+
require_relative "orb/models/webhooks/credit_note_issued_standard_webhook_event"
|
|
549
|
+
require_relative "orb/models/webhooks/credit_note_marked_as_void_standard_webhook_event"
|
|
550
|
+
require_relative "orb/models/webhooks/customer_accounting_sync_failed_standard_webhook_event"
|
|
551
|
+
require_relative "orb/models/webhooks/customer_accounting_sync_succeeded_standard_webhook_event"
|
|
552
|
+
require_relative "orb/models/webhooks/customer_balance_transaction_created_standard_webhook_event"
|
|
553
|
+
require_relative "orb/models/webhooks/customer_created_standard_webhook_event"
|
|
554
|
+
require_relative "orb/models/webhooks/customer_credit_balance_depleted_standard_webhook_event"
|
|
555
|
+
require_relative "orb/models/webhooks/customer_credit_balance_dropped_standard_webhook_event"
|
|
556
|
+
require_relative "orb/models/webhooks/customer_credit_balance_recovered_standard_webhook_event"
|
|
557
|
+
require_relative "orb/models/webhooks/customer_credit_ledger_incremented_standard_webhook_event"
|
|
558
|
+
require_relative "orb/models/webhooks/customer_edited_standard_webhook_event"
|
|
559
|
+
require_relative "orb/models/webhooks/data_exports_transfer_error_standard_webhook_event"
|
|
560
|
+
require_relative "orb/models/webhooks/data_exports_transfer_success_standard_webhook_event"
|
|
561
|
+
require_relative "orb/models/webhooks/event_unmatched_event_standard_webhook_event"
|
|
562
|
+
require_relative "orb/models/webhooks/ingestion_unmatched_customer_ids_standard_webhook_event"
|
|
563
|
+
require_relative "orb/models/webhooks/invoice_accounting_sync_failed_standard_webhook_event"
|
|
564
|
+
require_relative "orb/models/webhooks/invoice_accounting_sync_succeeded_standard_webhook_event"
|
|
565
|
+
require_relative "orb/models/webhooks/invoice_automation_schedule_step_executed_standard_webhook_event"
|
|
566
|
+
require_relative "orb/models/webhooks/invoice_cost_data_exported_standard_webhook_event"
|
|
567
|
+
require_relative "orb/models/webhooks/invoice_due_date_recalculation_canceled_standard_webhook_event"
|
|
568
|
+
require_relative "orb/models/webhooks/invoice_due_date_recalculation_completed_standard_webhook_event"
|
|
569
|
+
require_relative "orb/models/webhooks/invoice_due_date_recalculation_started_standard_webhook_event"
|
|
570
|
+
require_relative "orb/models/webhooks/invoice_dunning_schedule_created_standard_webhook_event"
|
|
571
|
+
require_relative "orb/models/webhooks/invoice_dunning_schedule_ended_standard_webhook_event"
|
|
572
|
+
require_relative "orb/models/webhooks/invoice_dunning_schedule_reset_standard_webhook_event"
|
|
573
|
+
require_relative "orb/models/webhooks/invoice_dunning_schedule_step_executed_standard_webhook_event"
|
|
574
|
+
require_relative "orb/models/webhooks/invoice_edited_standard_webhook_event"
|
|
575
|
+
require_relative "orb/models/webhooks/invoice_invoice_date_elapsed_standard_webhook_event"
|
|
576
|
+
require_relative "orb/models/webhooks/invoice_issued_standard_webhook_event"
|
|
577
|
+
require_relative "orb/models/webhooks/invoice_issued_summary_standard_webhook_event"
|
|
578
|
+
require_relative "orb/models/webhooks/invoice_issue_failed_standard_webhook_event"
|
|
579
|
+
require_relative "orb/models/webhooks/invoice_manually_marked_as_paid_standard_webhook_event"
|
|
580
|
+
require_relative "orb/models/webhooks/invoice_manually_marked_as_void_standard_webhook_event"
|
|
581
|
+
require_relative "orb/models/webhooks/invoice_payment_failed_standard_webhook_event"
|
|
582
|
+
require_relative "orb/models/webhooks/invoice_payment_processing_standard_webhook_event"
|
|
583
|
+
require_relative "orb/models/webhooks/invoice_payment_succeeded_standard_webhook_event"
|
|
584
|
+
require_relative "orb/models/webhooks/invoice_sync_failed_standard_webhook_event"
|
|
585
|
+
require_relative "orb/models/webhooks/invoice_sync_succeeded_standard_webhook_event"
|
|
586
|
+
require_relative "orb/models/webhooks/invoice_undo_mark_as_paid_standard_webhook_event"
|
|
587
|
+
require_relative "orb/models/webhooks/metric_events_dropped_by_watermark_standard_webhook_event"
|
|
588
|
+
require_relative "orb/models/webhooks/payment_method_created_standard_webhook_event"
|
|
589
|
+
require_relative "orb/models/webhooks/payment_method_deleted_standard_webhook_event"
|
|
590
|
+
require_relative "orb/models/webhooks/plan_created_standard_webhook_event"
|
|
591
|
+
require_relative "orb/models/webhooks/plan_default_version_set_standard_webhook_event"
|
|
592
|
+
require_relative "orb/models/webhooks/plan_edited_standard_webhook_event"
|
|
593
|
+
require_relative "orb/models/webhooks/plan_version_created_standard_webhook_event"
|
|
594
|
+
require_relative "orb/models/webhooks/price_edited_standard_webhook_event"
|
|
595
|
+
require_relative "orb/models/webhooks/resource_event_test_standard_webhook_event"
|
|
596
|
+
require_relative "orb/models/webhooks/sales_order_accounting_sync_failed_standard_webhook_event"
|
|
597
|
+
require_relative "orb/models/webhooks/sales_order_accounting_sync_succeeded_standard_webhook_event"
|
|
598
|
+
require_relative "orb/models/webhooks/standard_unwrap_standard_params"
|
|
599
|
+
require_relative "orb/models/webhooks/subscription_accounting_sync_failed_standard_webhook_event"
|
|
600
|
+
require_relative "orb/models/webhooks/subscription_accounting_sync_succeeded_standard_webhook_event"
|
|
601
|
+
require_relative "orb/models/webhooks/subscription_alert_disabled_standard_webhook_event"
|
|
602
|
+
require_relative "orb/models/webhooks/subscription_cancellation_scheduled_standard_webhook_event"
|
|
603
|
+
require_relative "orb/models/webhooks/subscription_cancellation_unscheduled_standard_webhook_event"
|
|
604
|
+
require_relative "orb/models/webhooks/subscription_cost_exceeded_standard_webhook_event"
|
|
605
|
+
require_relative "orb/models/webhooks/subscription_created_standard_webhook_event"
|
|
606
|
+
require_relative "orb/models/webhooks/subscription_edited_standard_webhook_event"
|
|
607
|
+
require_relative "orb/models/webhooks/subscription_ended_standard_webhook_event"
|
|
608
|
+
require_relative "orb/models/webhooks/subscription_fixed_fee_quantity_updated_standard_webhook_event"
|
|
609
|
+
require_relative "orb/models/webhooks/subscription_grouped_cost_exceeded_standard_webhook_event"
|
|
610
|
+
require_relative "orb/models/webhooks/subscription_invoicing_threshold_exceeded_standard_webhook_event"
|
|
611
|
+
require_relative "orb/models/webhooks/subscription_license_allocation_reset_standard_webhook_event"
|
|
612
|
+
require_relative "orb/models/webhooks/subscription_license_balance_threshold_reached_standard_webhook_event"
|
|
613
|
+
require_relative "orb/models/webhooks/subscription_plan_changed_standard_webhook_event"
|
|
614
|
+
require_relative "orb/models/webhooks/subscription_plan_change_scheduled_standard_webhook_event"
|
|
615
|
+
require_relative "orb/models/webhooks/subscription_plan_version_changed_standard_webhook_event"
|
|
616
|
+
require_relative "orb/models/webhooks/subscription_plan_version_change_scheduled_standard_webhook_event"
|
|
617
|
+
require_relative "orb/models/webhooks/subscription_spend_exceeded_standard_webhook_event"
|
|
618
|
+
require_relative "orb/models/webhooks/subscription_started_standard_webhook_event"
|
|
619
|
+
require_relative "orb/models/webhooks/subscription_trial_ended_standard_webhook_event"
|
|
620
|
+
require_relative "orb/models/webhooks/subscription_usage_exceeded_standard_webhook_event"
|
|
621
|
+
require_relative "orb/models/webhooks/transaction_accounting_sync_failed_standard_webhook_event"
|
|
622
|
+
require_relative "orb/models/webhooks/transaction_accounting_sync_succeeded_standard_webhook_event"
|
|
623
|
+
require_relative "orb/models/webhooks/unwrap_standard_webhook_event"
|
|
541
624
|
require_relative "orb/models/webhook_unwrap_params"
|
|
542
625
|
require_relative "orb/models"
|
|
543
626
|
require_relative "orb/resources/alerts"
|
|
@@ -577,3 +660,4 @@ require_relative "orb/resources/subscriptions"
|
|
|
577
660
|
require_relative "orb/resources/top_level"
|
|
578
661
|
require_relative "orb/resources/webhook_endpoints"
|
|
579
662
|
require_relative "orb/resources/webhooks"
|
|
663
|
+
require_relative "orb/resources/webhooks/standard"
|
|
@@ -358,7 +358,8 @@ module Orb
|
|
|
358
358
|
sig { returns(T::Boolean) }
|
|
359
359
|
attr_accessor :will_auto_issue
|
|
360
360
|
|
|
361
|
-
#
|
|
361
|
+
# An invoice without its line items, subtotal, discounts, minimums or maximums.
|
|
362
|
+
# Fetch the invoice for those.
|
|
362
363
|
sig do
|
|
363
364
|
params(
|
|
364
365
|
id: String,
|
|
@@ -16,7 +16,8 @@ module Orb
|
|
|
16
16
|
sig { returns(Time) }
|
|
17
17
|
attr_accessor :created_at
|
|
18
18
|
|
|
19
|
-
#
|
|
19
|
+
# An invoice without its line items, subtotal, discounts, minimums or maximums.
|
|
20
|
+
# Fetch the invoice for those.
|
|
20
21
|
sig { returns(Orb::InvoiceIssuedSummaryWebhookEvent::Invoice) }
|
|
21
22
|
attr_reader :invoice
|
|
22
23
|
|
|
@@ -68,7 +69,8 @@ module Orb
|
|
|
68
69
|
id:,
|
|
69
70
|
# The time at which this event was created, to the second.
|
|
70
71
|
created_at:,
|
|
71
|
-
#
|
|
72
|
+
# An invoice without its line items, subtotal, discounts, minimums or maximums.
|
|
73
|
+
# Fetch the invoice for those.
|
|
72
74
|
invoice:,
|
|
73
75
|
# The serialization style this payload was rendered in, as configured on the
|
|
74
76
|
# endpoint.
|
|
@@ -463,7 +465,8 @@ module Orb
|
|
|
463
465
|
sig { returns(T::Boolean) }
|
|
464
466
|
attr_accessor :will_auto_issue
|
|
465
467
|
|
|
466
|
-
#
|
|
468
|
+
# An invoice without its line items, subtotal, discounts, minimums or maximums.
|
|
469
|
+
# Fetch the invoice for those.
|
|
467
470
|
sig do
|
|
468
471
|
params(
|
|
469
472
|
id: String,
|
|
@@ -355,7 +355,8 @@ module Orb
|
|
|
355
355
|
sig { returns(T::Boolean) }
|
|
356
356
|
attr_accessor :will_auto_issue
|
|
357
357
|
|
|
358
|
-
#
|
|
358
|
+
# An invoice without its line items, subtotal, discounts, minimums or maximums.
|
|
359
|
+
# Fetch the invoice for those.
|
|
359
360
|
sig do
|
|
360
361
|
params(
|
|
361
362
|
id: String,
|