orb-billing 1.35.0 → 1.37.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 +35 -0
- data/README.md +1 -1
- data/lib/orb/client.rb +4 -0
- data/lib/orb/models/backfill_reflected_webhook_event.rb +180 -0
- data/lib/orb/models/backfill_reverted_webhook_event.rb +180 -0
- data/lib/orb/models/billable_metric_edited_webhook_event.rb +104 -0
- data/lib/orb/models/credit_block_accounting_sync_failed_webhook_event.rb +499 -0
- data/lib/orb/models/credit_block_accounting_sync_succeeded_webhook_event.rb +494 -0
- data/lib/orb/models/credit_note_accounting_sync_failed_webhook_event.rb +161 -0
- data/lib/orb/models/credit_note_accounting_sync_succeeded_webhook_event.rb +155 -0
- data/lib/orb/models/credit_note_issued_webhook_event.rb +65 -0
- data/lib/orb/models/credit_note_marked_as_void_webhook_event.rb +65 -0
- data/lib/orb/models/customer_accounting_sync_failed_webhook_event.rb +171 -0
- data/lib/orb/models/customer_accounting_sync_succeeded_webhook_event.rb +165 -0
- data/lib/orb/models/customer_balance_transaction_created_webhook_event.rb +212 -0
- data/lib/orb/models/customer_created_webhook_event.rb +81 -0
- data/lib/orb/models/customer_credit_balance_depleted_webhook_event.rb +560 -0
- data/lib/orb/models/customer_credit_balance_dropped_webhook_event.rb +566 -0
- data/lib/orb/models/customer_credit_balance_recovered_webhook_event.rb +560 -0
- data/lib/orb/models/customer_credit_ledger_incremented_webhook_event.rb +474 -0
- data/lib/orb/models/customer_edited_webhook_event.rb +344 -0
- data/lib/orb/models/data_exports_transfer_error_webhook_event.rb +100 -0
- data/lib/orb/models/data_exports_transfer_success_webhook_event.rb +94 -0
- data/lib/orb/models/event_unmatched_event_webhook_event.rb +105 -0
- data/lib/orb/models/ingestion_unmatched_customer_ids_webhook_event.rb +64 -0
- data/lib/orb/models/invoice_accounting_sync_failed_webhook_event.rb +164 -0
- data/lib/orb/models/invoice_accounting_sync_succeeded_webhook_event.rb +158 -0
- data/lib/orb/models/invoice_automation_schedule_step_executed_webhook_event.rb +338 -0
- data/lib/orb/models/invoice_cost_data_exported_webhook_event.rb +83 -0
- data/lib/orb/models/invoice_due_date_recalculation_canceled_webhook_event.rb +70 -0
- data/lib/orb/models/invoice_due_date_recalculation_completed_webhook_event.rb +70 -0
- data/lib/orb/models/invoice_due_date_recalculation_started_webhook_event.rb +64 -0
- data/lib/orb/models/invoice_dunning_schedule_created_webhook_event.rb +186 -0
- data/lib/orb/models/invoice_dunning_schedule_ended_webhook_event.rb +180 -0
- data/lib/orb/models/invoice_dunning_schedule_reset_webhook_event.rb +184 -0
- data/lib/orb/models/invoice_dunning_schedule_step_executed_webhook_event.rb +133 -0
- data/lib/orb/models/invoice_edited_webhook_event.rb +550 -0
- data/lib/orb/models/invoice_invoice_date_elapsed_webhook_event.rb +120 -0
- data/lib/orb/models/invoice_issue_failed_webhook_event.rb +79 -0
- data/lib/orb/models/invoice_issued_summary_webhook_event.rb +841 -0
- data/lib/orb/models/invoice_issued_webhook_event.rb +79 -0
- data/lib/orb/models/invoice_manually_marked_as_paid_webhook_event.rb +91 -0
- data/lib/orb/models/invoice_manually_marked_as_void_webhook_event.rb +68 -0
- data/lib/orb/models/invoice_payment_failed_webhook_event.rb +92 -0
- data/lib/orb/models/invoice_payment_processing_webhook_event.rb +85 -0
- data/lib/orb/models/invoice_payment_succeeded_webhook_event.rb +101 -0
- data/lib/orb/models/invoice_sync_failed_webhook_event.rb +85 -0
- data/lib/orb/models/invoice_sync_succeeded_webhook_event.rb +85 -0
- data/lib/orb/models/invoice_undo_mark_as_paid_webhook_event.rb +68 -0
- data/lib/orb/models/metric_events_dropped_by_watermark_webhook_event.rb +98 -0
- data/lib/orb/models/payment_method_created_webhook_event.rb +156 -0
- data/lib/orb/models/payment_method_deleted_webhook_event.rb +156 -0
- data/lib/orb/models/plan_default_version_set_webhook_event.rb +108 -0
- data/lib/orb/models/plan_version_created_webhook_event.rb +108 -0
- data/lib/orb/models/price_edited_webhook_event.rb +105 -0
- data/lib/orb/models/resource_event_test_webhook_event.rb +64 -0
- data/lib/orb/models/sales_order_accounting_sync_failed_webhook_event.rb +164 -0
- data/lib/orb/models/sales_order_accounting_sync_succeeded_webhook_event.rb +158 -0
- data/lib/orb/models/subscription_accounting_sync_failed_webhook_event.rb +178 -0
- data/lib/orb/models/subscription_accounting_sync_succeeded_webhook_event.rb +172 -0
- data/lib/orb/models/subscription_alert_disabled_webhook_event.rb +624 -0
- data/lib/orb/models/subscription_cancellation_scheduled_webhook_event.rb +93 -0
- data/lib/orb/models/subscription_cancellation_unscheduled_webhook_event.rb +93 -0
- data/lib/orb/models/subscription_cost_exceeded_webhook_event.rb +540 -0
- data/lib/orb/models/subscription_created_webhook_event.rb +82 -0
- data/lib/orb/models/subscription_edited_webhook_event.rb +134 -0
- data/lib/orb/models/subscription_ended_webhook_event.rb +82 -0
- data/lib/orb/models/subscription_fixed_fee_quantity_updated_webhook_event.rb +111 -0
- data/lib/orb/models/subscription_grouped_cost_exceeded_webhook_event.rb +655 -0
- data/lib/orb/models/subscription_invoicing_threshold_exceeded_webhook_event.rb +191 -0
- data/lib/orb/models/subscription_license_allocation_reset_webhook_event.rb +214 -0
- data/lib/orb/models/subscription_license_balance_threshold_reached_webhook_event.rb +652 -0
- data/lib/orb/models/subscription_plan_change_scheduled_webhook_event.rb +105 -0
- data/lib/orb/models/subscription_plan_changed_webhook_event.rb +93 -0
- data/lib/orb/models/subscription_plan_version_change_scheduled_webhook_event.rb +106 -0
- data/lib/orb/models/subscription_plan_version_changed_webhook_event.rb +105 -0
- data/lib/orb/models/subscription_spend_exceeded_webhook_event.rb +541 -0
- data/lib/orb/models/subscription_started_webhook_event.rb +82 -0
- data/lib/orb/models/subscription_trial_ended_webhook_event.rb +82 -0
- data/lib/orb/models/subscription_usage_exceeded_webhook_event.rb +548 -0
- data/lib/orb/models/transaction_accounting_sync_failed_webhook_event.rb +236 -0
- data/lib/orb/models/transaction_accounting_sync_succeeded_webhook_event.rb +232 -0
- data/lib/orb/models/unwrap_webhook_event.rb +250 -0
- data/lib/orb/models/webhook_unwrap_params.rb +14 -0
- data/lib/orb/models.rb +180 -0
- data/lib/orb/resources/webhooks.rb +22 -0
- data/lib/orb/version.rb +1 -1
- data/lib/orb.rb +82 -0
- data/rbi/orb/client.rbi +3 -0
- data/rbi/orb/models/backfill_reflected_webhook_event.rbi +274 -0
- data/rbi/orb/models/backfill_reverted_webhook_event.rbi +271 -0
- data/rbi/orb/models/billable_metric_edited_webhook_event.rbi +198 -0
- data/rbi/orb/models/credit_block_accounting_sync_failed_webhook_event.rbi +1039 -0
- data/rbi/orb/models/credit_block_accounting_sync_succeeded_webhook_event.rbi +1034 -0
- data/rbi/orb/models/credit_note_accounting_sync_failed_webhook_event.rbi +315 -0
- data/rbi/orb/models/credit_note_accounting_sync_succeeded_webhook_event.rbi +310 -0
- data/rbi/orb/models/credit_note_issued_webhook_event.rbi +98 -0
- data/rbi/orb/models/credit_note_marked_as_void_webhook_event.rbi +102 -0
- data/rbi/orb/models/customer_accounting_sync_failed_webhook_event.rbi +339 -0
- data/rbi/orb/models/customer_accounting_sync_succeeded_webhook_event.rbi +335 -0
- data/rbi/orb/models/customer_balance_transaction_created_webhook_event.rbi +437 -0
- data/rbi/orb/models/customer_created_webhook_event.rbi +128 -0
- data/rbi/orb/models/customer_credit_balance_depleted_webhook_event.rbi +1091 -0
- data/rbi/orb/models/customer_credit_balance_dropped_webhook_event.rbi +1096 -0
- data/rbi/orb/models/customer_credit_balance_recovered_webhook_event.rbi +1091 -0
- data/rbi/orb/models/customer_credit_ledger_incremented_webhook_event.rbi +987 -0
- data/rbi/orb/models/customer_edited_webhook_event.rbi +599 -0
- data/rbi/orb/models/data_exports_transfer_error_webhook_event.rbi +170 -0
- data/rbi/orb/models/data_exports_transfer_success_webhook_event.rbi +165 -0
- data/rbi/orb/models/event_unmatched_event_webhook_event.rbi +193 -0
- data/rbi/orb/models/ingestion_unmatched_customer_ids_webhook_event.rbi +132 -0
- data/rbi/orb/models/invoice_accounting_sync_failed_webhook_event.rbi +319 -0
- data/rbi/orb/models/invoice_accounting_sync_succeeded_webhook_event.rbi +312 -0
- data/rbi/orb/models/invoice_automation_schedule_step_executed_webhook_event.rbi +614 -0
- data/rbi/orb/models/invoice_cost_data_exported_webhook_event.rbi +144 -0
- data/rbi/orb/models/invoice_due_date_recalculation_canceled_webhook_event.rbi +139 -0
- data/rbi/orb/models/invoice_due_date_recalculation_completed_webhook_event.rbi +139 -0
- data/rbi/orb/models/invoice_due_date_recalculation_started_webhook_event.rbi +132 -0
- data/rbi/orb/models/invoice_dunning_schedule_created_webhook_event.rbi +331 -0
- data/rbi/orb/models/invoice_dunning_schedule_ended_webhook_event.rbi +324 -0
- data/rbi/orb/models/invoice_dunning_schedule_reset_webhook_event.rbi +329 -0
- data/rbi/orb/models/invoice_dunning_schedule_step_executed_webhook_event.rbi +250 -0
- data/rbi/orb/models/invoice_edited_webhook_event.rbi +942 -0
- data/rbi/orb/models/invoice_invoice_date_elapsed_webhook_event.rbi +251 -0
- data/rbi/orb/models/invoice_issue_failed_webhook_event.rbi +132 -0
- data/rbi/orb/models/invoice_issued_summary_webhook_event.rbi +1432 -0
- data/rbi/orb/models/invoice_issued_webhook_event.rbi +134 -0
- data/rbi/orb/models/invoice_manually_marked_as_paid_webhook_event.rbi +165 -0
- data/rbi/orb/models/invoice_manually_marked_as_void_webhook_event.rbi +114 -0
- data/rbi/orb/models/invoice_payment_failed_webhook_event.rbi +157 -0
- data/rbi/orb/models/invoice_payment_processing_webhook_event.rbi +156 -0
- data/rbi/orb/models/invoice_payment_succeeded_webhook_event.rbi +175 -0
- data/rbi/orb/models/invoice_sync_failed_webhook_event.rbi +147 -0
- data/rbi/orb/models/invoice_sync_succeeded_webhook_event.rbi +147 -0
- data/rbi/orb/models/invoice_undo_mark_as_paid_webhook_event.rbi +106 -0
- data/rbi/orb/models/metric_events_dropped_by_watermark_webhook_event.rbi +167 -0
- data/rbi/orb/models/payment_method_created_webhook_event.rbi +259 -0
- data/rbi/orb/models/payment_method_deleted_webhook_event.rbi +259 -0
- data/rbi/orb/models/plan_default_version_set_webhook_event.rbi +196 -0
- data/rbi/orb/models/plan_version_created_webhook_event.rbi +190 -0
- data/rbi/orb/models/price_edited_webhook_event.rbi +235 -0
- data/rbi/orb/models/resource_event_test_webhook_event.rbi +116 -0
- data/rbi/orb/models/sales_order_accounting_sync_failed_webhook_event.rbi +321 -0
- data/rbi/orb/models/sales_order_accounting_sync_succeeded_webhook_event.rbi +316 -0
- data/rbi/orb/models/subscription_accounting_sync_failed_webhook_event.rbi +353 -0
- data/rbi/orb/models/subscription_accounting_sync_succeeded_webhook_event.rbi +346 -0
- data/rbi/orb/models/subscription_alert_disabled_webhook_event.rbi +1232 -0
- data/rbi/orb/models/subscription_cancellation_scheduled_webhook_event.rbi +179 -0
- data/rbi/orb/models/subscription_cancellation_unscheduled_webhook_event.rbi +183 -0
- data/rbi/orb/models/subscription_cost_exceeded_webhook_event.rbi +1034 -0
- data/rbi/orb/models/subscription_created_webhook_event.rbi +132 -0
- data/rbi/orb/models/subscription_edited_webhook_event.rbi +247 -0
- data/rbi/orb/models/subscription_ended_webhook_event.rbi +132 -0
- data/rbi/orb/models/subscription_fixed_fee_quantity_updated_webhook_event.rbi +206 -0
- data/rbi/orb/models/subscription_grouped_cost_exceeded_webhook_event.rbi +1262 -0
- data/rbi/orb/models/subscription_invoicing_threshold_exceeded_webhook_event.rbi +374 -0
- data/rbi/orb/models/subscription_license_allocation_reset_webhook_event.rbi +421 -0
- data/rbi/orb/models/subscription_license_balance_threshold_reached_webhook_event.rbi +1265 -0
- data/rbi/orb/models/subscription_plan_change_scheduled_webhook_event.rbi +198 -0
- data/rbi/orb/models/subscription_plan_changed_webhook_event.rbi +169 -0
- data/rbi/orb/models/subscription_plan_version_change_scheduled_webhook_event.rbi +205 -0
- data/rbi/orb/models/subscription_plan_version_changed_webhook_event.rbi +199 -0
- data/rbi/orb/models/subscription_spend_exceeded_webhook_event.rbi +1035 -0
- data/rbi/orb/models/subscription_started_webhook_event.rbi +132 -0
- data/rbi/orb/models/subscription_trial_ended_webhook_event.rbi +136 -0
- data/rbi/orb/models/subscription_usage_exceeded_webhook_event.rbi +1041 -0
- data/rbi/orb/models/transaction_accounting_sync_failed_webhook_event.rbi +455 -0
- data/rbi/orb/models/transaction_accounting_sync_succeeded_webhook_event.rbi +449 -0
- data/rbi/orb/models/unwrap_webhook_event.rbi +99 -0
- data/rbi/orb/models/webhook_unwrap_params.rbi +25 -0
- data/rbi/orb/models.rbi +224 -0
- data/rbi/orb/resources/webhooks.rbi +103 -0
- data/sig/orb/client.rbs +2 -0
- data/sig/orb/models/backfill_reflected_webhook_event.rbs +130 -0
- data/sig/orb/models/backfill_reverted_webhook_event.rbs +130 -0
- data/sig/orb/models/billable_metric_edited_webhook_event.rbs +94 -0
- data/sig/orb/models/credit_block_accounting_sync_failed_webhook_event.rbs +412 -0
- data/sig/orb/models/credit_block_accounting_sync_succeeded_webhook_event.rbs +407 -0
- data/sig/orb/models/credit_note_accounting_sync_failed_webhook_event.rbs +147 -0
- data/sig/orb/models/credit_note_accounting_sync_succeeded_webhook_event.rbs +142 -0
- data/sig/orb/models/credit_note_issued_webhook_event.rbs +50 -0
- data/sig/orb/models/credit_note_marked_as_void_webhook_event.rbs +50 -0
- data/sig/orb/models/customer_accounting_sync_failed_webhook_event.rbs +142 -0
- data/sig/orb/models/customer_accounting_sync_succeeded_webhook_event.rbs +137 -0
- data/sig/orb/models/customer_balance_transaction_created_webhook_event.rbs +171 -0
- data/sig/orb/models/customer_created_webhook_event.rbs +50 -0
- data/sig/orb/models/customer_credit_balance_depleted_webhook_event.rbs +374 -0
- data/sig/orb/models/customer_credit_balance_dropped_webhook_event.rbs +379 -0
- data/sig/orb/models/customer_credit_balance_recovered_webhook_event.rbs +374 -0
- data/sig/orb/models/customer_credit_ledger_incremented_webhook_event.rbs +364 -0
- data/sig/orb/models/customer_edited_webhook_event.rbs +139 -0
- data/sig/orb/models/data_exports_transfer_error_webhook_event.rbs +92 -0
- data/sig/orb/models/data_exports_transfer_success_webhook_event.rbs +87 -0
- data/sig/orb/models/event_unmatched_event_webhook_event.rbs +102 -0
- data/sig/orb/models/ingestion_unmatched_customer_ids_webhook_event.rbs +55 -0
- data/sig/orb/models/invoice_accounting_sync_failed_webhook_event.rbs +147 -0
- data/sig/orb/models/invoice_accounting_sync_succeeded_webhook_event.rbs +142 -0
- data/sig/orb/models/invoice_automation_schedule_step_executed_webhook_event.rbs +313 -0
- data/sig/orb/models/invoice_cost_data_exported_webhook_event.rbs +73 -0
- data/sig/orb/models/invoice_due_date_recalculation_canceled_webhook_event.rbs +57 -0
- data/sig/orb/models/invoice_due_date_recalculation_completed_webhook_event.rbs +57 -0
- data/sig/orb/models/invoice_due_date_recalculation_started_webhook_event.rbs +55 -0
- data/sig/orb/models/invoice_dunning_schedule_created_webhook_event.rbs +171 -0
- data/sig/orb/models/invoice_dunning_schedule_ended_webhook_event.rbs +166 -0
- data/sig/orb/models/invoice_dunning_schedule_reset_webhook_event.rbs +156 -0
- data/sig/orb/models/invoice_dunning_schedule_step_executed_webhook_event.rbs +119 -0
- data/sig/orb/models/invoice_edited_webhook_event.rbs +388 -0
- data/sig/orb/models/invoice_invoice_date_elapsed_webhook_event.rbs +111 -0
- data/sig/orb/models/invoice_issue_failed_webhook_event.rbs +60 -0
- data/sig/orb/models/invoice_issued_summary_webhook_event.rbs +504 -0
- data/sig/orb/models/invoice_issued_webhook_event.rbs +60 -0
- data/sig/orb/models/invoice_manually_marked_as_paid_webhook_event.rbs +73 -0
- data/sig/orb/models/invoice_manually_marked_as_void_webhook_event.rbs +50 -0
- data/sig/orb/models/invoice_payment_failed_webhook_event.rbs +77 -0
- data/sig/orb/models/invoice_payment_processing_webhook_event.rbs +71 -0
- data/sig/orb/models/invoice_payment_succeeded_webhook_event.rbs +82 -0
- data/sig/orb/models/invoice_sync_failed_webhook_event.rbs +69 -0
- data/sig/orb/models/invoice_sync_succeeded_webhook_event.rbs +69 -0
- data/sig/orb/models/invoice_undo_mark_as_paid_webhook_event.rbs +50 -0
- data/sig/orb/models/metric_events_dropped_by_watermark_webhook_event.rbs +82 -0
- data/sig/orb/models/payment_method_created_webhook_event.rbs +112 -0
- data/sig/orb/models/payment_method_deleted_webhook_event.rbs +112 -0
- data/sig/orb/models/plan_default_version_set_webhook_event.rbs +94 -0
- data/sig/orb/models/plan_version_created_webhook_event.rbs +91 -0
- data/sig/orb/models/price_edited_webhook_event.rbs +77 -0
- data/sig/orb/models/resource_event_test_webhook_event.rbs +57 -0
- data/sig/orb/models/sales_order_accounting_sync_failed_webhook_event.rbs +147 -0
- data/sig/orb/models/sales_order_accounting_sync_succeeded_webhook_event.rbs +142 -0
- data/sig/orb/models/subscription_accounting_sync_failed_webhook_event.rbs +147 -0
- data/sig/orb/models/subscription_accounting_sync_succeeded_webhook_event.rbs +142 -0
- data/sig/orb/models/subscription_alert_disabled_webhook_event.rbs +444 -0
- data/sig/orb/models/subscription_cancellation_scheduled_webhook_event.rbs +60 -0
- data/sig/orb/models/subscription_cancellation_unscheduled_webhook_event.rbs +60 -0
- data/sig/orb/models/subscription_cost_exceeded_webhook_event.rbs +362 -0
- data/sig/orb/models/subscription_created_webhook_event.rbs +50 -0
- data/sig/orb/models/subscription_edited_webhook_event.rbs +109 -0
- data/sig/orb/models/subscription_ended_webhook_event.rbs +50 -0
- data/sig/orb/models/subscription_fixed_fee_quantity_updated_webhook_event.rbs +82 -0
- data/sig/orb/models/subscription_grouped_cost_exceeded_webhook_event.rbs +465 -0
- data/sig/orb/models/subscription_invoicing_threshold_exceeded_webhook_event.rbs +158 -0
- data/sig/orb/models/subscription_license_allocation_reset_webhook_event.rbs +180 -0
- data/sig/orb/models/subscription_license_balance_threshold_reached_webhook_event.rbs +460 -0
- data/sig/orb/models/subscription_plan_change_scheduled_webhook_event.rbs +73 -0
- data/sig/orb/models/subscription_plan_changed_webhook_event.rbs +60 -0
- data/sig/orb/models/subscription_plan_version_change_scheduled_webhook_event.rbs +77 -0
- data/sig/orb/models/subscription_plan_version_changed_webhook_event.rbs +77 -0
- data/sig/orb/models/subscription_spend_exceeded_webhook_event.rbs +362 -0
- data/sig/orb/models/subscription_started_webhook_event.rbs +50 -0
- data/sig/orb/models/subscription_trial_ended_webhook_event.rbs +50 -0
- data/sig/orb/models/subscription_usage_exceeded_webhook_event.rbs +367 -0
- data/sig/orb/models/transaction_accounting_sync_failed_webhook_event.rbs +205 -0
- data/sig/orb/models/transaction_accounting_sync_succeeded_webhook_event.rbs +200 -0
- data/sig/orb/models/unwrap_webhook_event.rbs +90 -0
- data/sig/orb/models/webhook_unwrap_params.rbs +14 -0
- data/sig/orb/models.rbs +162 -0
- data/sig/orb/resources/webhooks.rbs +89 -0
- metadata +247 -1
|
@@ -0,0 +1,186 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Orb
|
|
4
|
+
module Models
|
|
5
|
+
class InvoiceDunningScheduleCreatedWebhookEvent < Orb::Internal::Type::BaseModel
|
|
6
|
+
# @!attribute id
|
|
7
|
+
# The ID of this webhook event.
|
|
8
|
+
#
|
|
9
|
+
# @return [String]
|
|
10
|
+
required :id, String
|
|
11
|
+
|
|
12
|
+
# @!attribute created_at
|
|
13
|
+
# The time at which this event was created, to the second.
|
|
14
|
+
#
|
|
15
|
+
# @return [Time]
|
|
16
|
+
required :created_at, Time
|
|
17
|
+
|
|
18
|
+
# @!attribute invoice
|
|
19
|
+
# An [`Invoice`](/core-concepts#invoice) is a fundamental billing entity,
|
|
20
|
+
# representing the request for payment for a single subscription. This includes a
|
|
21
|
+
# set of line items, which correspond to prices in the subscription's plan and can
|
|
22
|
+
# represent fixed recurring fees or usage-based fees. They are generated at the
|
|
23
|
+
# end of a billing period, or as the result of an action, such as a cancellation.
|
|
24
|
+
#
|
|
25
|
+
# @return [Orb::Models::Invoice]
|
|
26
|
+
required :invoice, -> { Orb::Invoice }
|
|
27
|
+
|
|
28
|
+
# @!attribute properties
|
|
29
|
+
#
|
|
30
|
+
# @return [Orb::Models::InvoiceDunningScheduleCreatedWebhookEvent::Properties]
|
|
31
|
+
required :properties, -> { Orb::InvoiceDunningScheduleCreatedWebhookEvent::Properties }
|
|
32
|
+
|
|
33
|
+
# @!attribute type
|
|
34
|
+
# The event this payload describes.
|
|
35
|
+
#
|
|
36
|
+
# @return [Symbol, Orb::Models::InvoiceDunningScheduleCreatedWebhookEvent::Type]
|
|
37
|
+
required :type, enum: -> { Orb::InvoiceDunningScheduleCreatedWebhookEvent::Type }
|
|
38
|
+
|
|
39
|
+
# @!method initialize(id:, created_at:, invoice:, properties:, type:)
|
|
40
|
+
# Some parameter documentations has been truncated, see
|
|
41
|
+
# {Orb::Models::InvoiceDunningScheduleCreatedWebhookEvent} for more details.
|
|
42
|
+
#
|
|
43
|
+
# Issued when a dunning schedule is created for an invoice.
|
|
44
|
+
#
|
|
45
|
+
# @param id [String] The ID of this webhook event.
|
|
46
|
+
#
|
|
47
|
+
# @param created_at [Time] The time at which this event was created, to the second.
|
|
48
|
+
#
|
|
49
|
+
# @param invoice [Orb::Models::Invoice] An [`Invoice`](/core-concepts#invoice) is a fundamental billing entity, represen
|
|
50
|
+
#
|
|
51
|
+
# @param properties [Orb::Models::InvoiceDunningScheduleCreatedWebhookEvent::Properties]
|
|
52
|
+
#
|
|
53
|
+
# @param type [Symbol, Orb::Models::InvoiceDunningScheduleCreatedWebhookEvent::Type] The event this payload describes.
|
|
54
|
+
|
|
55
|
+
# @see Orb::Models::InvoiceDunningScheduleCreatedWebhookEvent#properties
|
|
56
|
+
class Properties < Orb::Internal::Type::BaseModel
|
|
57
|
+
# @!attribute dunning_schedule
|
|
58
|
+
#
|
|
59
|
+
# @return [Orb::Models::InvoiceDunningScheduleCreatedWebhookEvent::Properties::DunningSchedule]
|
|
60
|
+
required :dunning_schedule,
|
|
61
|
+
-> { Orb::InvoiceDunningScheduleCreatedWebhookEvent::Properties::DunningSchedule }
|
|
62
|
+
|
|
63
|
+
# @!attribute dunning_steps
|
|
64
|
+
#
|
|
65
|
+
# @return [Array<Orb::Models::InvoiceDunningScheduleCreatedWebhookEvent::Properties::DunningStep>]
|
|
66
|
+
required :dunning_steps,
|
|
67
|
+
-> { Orb::Internal::Type::ArrayOf[Orb::InvoiceDunningScheduleCreatedWebhookEvent::Properties::DunningStep] }
|
|
68
|
+
|
|
69
|
+
# @!attribute source
|
|
70
|
+
#
|
|
71
|
+
# @return [String]
|
|
72
|
+
required :source, String
|
|
73
|
+
|
|
74
|
+
# @!method initialize(dunning_schedule:, dunning_steps:, source:)
|
|
75
|
+
# @param dunning_schedule [Orb::Models::InvoiceDunningScheduleCreatedWebhookEvent::Properties::DunningSchedule]
|
|
76
|
+
# @param dunning_steps [Array<Orb::Models::InvoiceDunningScheduleCreatedWebhookEvent::Properties::DunningStep>]
|
|
77
|
+
# @param source [String]
|
|
78
|
+
|
|
79
|
+
# @see Orb::Models::InvoiceDunningScheduleCreatedWebhookEvent::Properties#dunning_schedule
|
|
80
|
+
class DunningSchedule < Orb::Internal::Type::BaseModel
|
|
81
|
+
# @!attribute completion_time
|
|
82
|
+
#
|
|
83
|
+
# @return [Time, nil]
|
|
84
|
+
required :completion_time, Time, nil?: true
|
|
85
|
+
|
|
86
|
+
# @!attribute created_at
|
|
87
|
+
#
|
|
88
|
+
# @return [Time, nil]
|
|
89
|
+
required :created_at, Time, nil?: true
|
|
90
|
+
|
|
91
|
+
# @!attribute invoice_id
|
|
92
|
+
#
|
|
93
|
+
# @return [String]
|
|
94
|
+
required :invoice_id, String
|
|
95
|
+
|
|
96
|
+
# @!attribute modified_at
|
|
97
|
+
#
|
|
98
|
+
# @return [Time, nil]
|
|
99
|
+
required :modified_at, Time, nil?: true
|
|
100
|
+
|
|
101
|
+
# @!attribute start_time
|
|
102
|
+
#
|
|
103
|
+
# @return [Time, nil]
|
|
104
|
+
required :start_time, Time, nil?: true
|
|
105
|
+
|
|
106
|
+
# @!attribute status
|
|
107
|
+
#
|
|
108
|
+
# @return [String]
|
|
109
|
+
required :status, String
|
|
110
|
+
|
|
111
|
+
# @!method initialize(completion_time:, created_at:, invoice_id:, modified_at:, start_time:, status:)
|
|
112
|
+
# @param completion_time [Time, nil]
|
|
113
|
+
# @param created_at [Time, nil]
|
|
114
|
+
# @param invoice_id [String]
|
|
115
|
+
# @param modified_at [Time, nil]
|
|
116
|
+
# @param start_time [Time, nil]
|
|
117
|
+
# @param status [String]
|
|
118
|
+
end
|
|
119
|
+
|
|
120
|
+
class DunningStep < Orb::Internal::Type::BaseModel
|
|
121
|
+
# @!attribute actions
|
|
122
|
+
#
|
|
123
|
+
# @return [Array<String>]
|
|
124
|
+
required :actions, Orb::Internal::Type::ArrayOf[String]
|
|
125
|
+
|
|
126
|
+
# @!attribute created_at
|
|
127
|
+
#
|
|
128
|
+
# @return [Time, nil]
|
|
129
|
+
required :created_at, Time, nil?: true
|
|
130
|
+
|
|
131
|
+
# @!attribute execution_time
|
|
132
|
+
#
|
|
133
|
+
# @return [Time, nil]
|
|
134
|
+
required :execution_time, Time, nil?: true
|
|
135
|
+
|
|
136
|
+
# @!attribute manually_triggered_at
|
|
137
|
+
#
|
|
138
|
+
# @return [Time, nil]
|
|
139
|
+
required :manually_triggered_at, Time, nil?: true
|
|
140
|
+
|
|
141
|
+
# @!attribute modified_at
|
|
142
|
+
#
|
|
143
|
+
# @return [Time, nil]
|
|
144
|
+
required :modified_at, Time, nil?: true
|
|
145
|
+
|
|
146
|
+
# @!attribute status
|
|
147
|
+
#
|
|
148
|
+
# @return [String]
|
|
149
|
+
required :status, String
|
|
150
|
+
|
|
151
|
+
# @!attribute step_number
|
|
152
|
+
#
|
|
153
|
+
# @return [Integer, nil]
|
|
154
|
+
required :step_number, Integer, nil?: true
|
|
155
|
+
|
|
156
|
+
# @!attribute timestamp
|
|
157
|
+
#
|
|
158
|
+
# @return [Time, nil]
|
|
159
|
+
required :timestamp, Time, nil?: true
|
|
160
|
+
|
|
161
|
+
# @!method initialize(actions:, created_at:, execution_time:, manually_triggered_at:, modified_at:, status:, step_number:, timestamp:)
|
|
162
|
+
# @param actions [Array<String>]
|
|
163
|
+
# @param created_at [Time, nil]
|
|
164
|
+
# @param execution_time [Time, nil]
|
|
165
|
+
# @param manually_triggered_at [Time, nil]
|
|
166
|
+
# @param modified_at [Time, nil]
|
|
167
|
+
# @param status [String]
|
|
168
|
+
# @param step_number [Integer, nil]
|
|
169
|
+
# @param timestamp [Time, nil]
|
|
170
|
+
end
|
|
171
|
+
end
|
|
172
|
+
|
|
173
|
+
# The event this payload describes.
|
|
174
|
+
#
|
|
175
|
+
# @see Orb::Models::InvoiceDunningScheduleCreatedWebhookEvent#type
|
|
176
|
+
module Type
|
|
177
|
+
extend Orb::Internal::Type::Enum
|
|
178
|
+
|
|
179
|
+
INVOICE_DUNNING_SCHEDULE_CREATED = :"invoice.dunning_schedule_created"
|
|
180
|
+
|
|
181
|
+
# @!method self.values
|
|
182
|
+
# @return [Array<Symbol>]
|
|
183
|
+
end
|
|
184
|
+
end
|
|
185
|
+
end
|
|
186
|
+
end
|
|
@@ -0,0 +1,180 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Orb
|
|
4
|
+
module Models
|
|
5
|
+
class InvoiceDunningScheduleEndedWebhookEvent < Orb::Internal::Type::BaseModel
|
|
6
|
+
# @!attribute id
|
|
7
|
+
# The ID of this webhook event.
|
|
8
|
+
#
|
|
9
|
+
# @return [String]
|
|
10
|
+
required :id, String
|
|
11
|
+
|
|
12
|
+
# @!attribute created_at
|
|
13
|
+
# The time at which this event was created, to the second.
|
|
14
|
+
#
|
|
15
|
+
# @return [Time]
|
|
16
|
+
required :created_at, Time
|
|
17
|
+
|
|
18
|
+
# @!attribute invoice
|
|
19
|
+
# An [`Invoice`](/core-concepts#invoice) is a fundamental billing entity,
|
|
20
|
+
# representing the request for payment for a single subscription. This includes a
|
|
21
|
+
# set of line items, which correspond to prices in the subscription's plan and can
|
|
22
|
+
# represent fixed recurring fees or usage-based fees. They are generated at the
|
|
23
|
+
# end of a billing period, or as the result of an action, such as a cancellation.
|
|
24
|
+
#
|
|
25
|
+
# @return [Orb::Models::Invoice]
|
|
26
|
+
required :invoice, -> { Orb::Invoice }
|
|
27
|
+
|
|
28
|
+
# @!attribute properties
|
|
29
|
+
#
|
|
30
|
+
# @return [Orb::Models::InvoiceDunningScheduleEndedWebhookEvent::Properties]
|
|
31
|
+
required :properties, -> { Orb::InvoiceDunningScheduleEndedWebhookEvent::Properties }
|
|
32
|
+
|
|
33
|
+
# @!attribute type
|
|
34
|
+
# The event this payload describes.
|
|
35
|
+
#
|
|
36
|
+
# @return [Symbol, Orb::Models::InvoiceDunningScheduleEndedWebhookEvent::Type]
|
|
37
|
+
required :type, enum: -> { Orb::InvoiceDunningScheduleEndedWebhookEvent::Type }
|
|
38
|
+
|
|
39
|
+
# @!method initialize(id:, created_at:, invoice:, properties:, type:)
|
|
40
|
+
# Some parameter documentations has been truncated, see
|
|
41
|
+
# {Orb::Models::InvoiceDunningScheduleEndedWebhookEvent} for more details.
|
|
42
|
+
#
|
|
43
|
+
# Issued when a dunning schedule ends.
|
|
44
|
+
#
|
|
45
|
+
# @param id [String] The ID of this webhook event.
|
|
46
|
+
#
|
|
47
|
+
# @param created_at [Time] The time at which this event was created, to the second.
|
|
48
|
+
#
|
|
49
|
+
# @param invoice [Orb::Models::Invoice] An [`Invoice`](/core-concepts#invoice) is a fundamental billing entity, represen
|
|
50
|
+
#
|
|
51
|
+
# @param properties [Orb::Models::InvoiceDunningScheduleEndedWebhookEvent::Properties]
|
|
52
|
+
#
|
|
53
|
+
# @param type [Symbol, Orb::Models::InvoiceDunningScheduleEndedWebhookEvent::Type] The event this payload describes.
|
|
54
|
+
|
|
55
|
+
# @see Orb::Models::InvoiceDunningScheduleEndedWebhookEvent#properties
|
|
56
|
+
class Properties < Orb::Internal::Type::BaseModel
|
|
57
|
+
# @!attribute dunning_schedule
|
|
58
|
+
#
|
|
59
|
+
# @return [Orb::Models::InvoiceDunningScheduleEndedWebhookEvent::Properties::DunningSchedule]
|
|
60
|
+
required :dunning_schedule,
|
|
61
|
+
-> { Orb::InvoiceDunningScheduleEndedWebhookEvent::Properties::DunningSchedule }
|
|
62
|
+
|
|
63
|
+
# @!attribute dunning_steps
|
|
64
|
+
#
|
|
65
|
+
# @return [Array<Orb::Models::InvoiceDunningScheduleEndedWebhookEvent::Properties::DunningStep>]
|
|
66
|
+
required :dunning_steps,
|
|
67
|
+
-> { Orb::Internal::Type::ArrayOf[Orb::InvoiceDunningScheduleEndedWebhookEvent::Properties::DunningStep] }
|
|
68
|
+
|
|
69
|
+
# @!method initialize(dunning_schedule:, dunning_steps:)
|
|
70
|
+
# @param dunning_schedule [Orb::Models::InvoiceDunningScheduleEndedWebhookEvent::Properties::DunningSchedule]
|
|
71
|
+
# @param dunning_steps [Array<Orb::Models::InvoiceDunningScheduleEndedWebhookEvent::Properties::DunningStep>]
|
|
72
|
+
|
|
73
|
+
# @see Orb::Models::InvoiceDunningScheduleEndedWebhookEvent::Properties#dunning_schedule
|
|
74
|
+
class DunningSchedule < Orb::Internal::Type::BaseModel
|
|
75
|
+
# @!attribute completion_time
|
|
76
|
+
#
|
|
77
|
+
# @return [Time, nil]
|
|
78
|
+
required :completion_time, Time, nil?: true
|
|
79
|
+
|
|
80
|
+
# @!attribute created_at
|
|
81
|
+
#
|
|
82
|
+
# @return [Time, nil]
|
|
83
|
+
required :created_at, Time, nil?: true
|
|
84
|
+
|
|
85
|
+
# @!attribute invoice_id
|
|
86
|
+
#
|
|
87
|
+
# @return [String]
|
|
88
|
+
required :invoice_id, String
|
|
89
|
+
|
|
90
|
+
# @!attribute modified_at
|
|
91
|
+
#
|
|
92
|
+
# @return [Time, nil]
|
|
93
|
+
required :modified_at, Time, nil?: true
|
|
94
|
+
|
|
95
|
+
# @!attribute start_time
|
|
96
|
+
#
|
|
97
|
+
# @return [Time, nil]
|
|
98
|
+
required :start_time, Time, nil?: true
|
|
99
|
+
|
|
100
|
+
# @!attribute status
|
|
101
|
+
#
|
|
102
|
+
# @return [String]
|
|
103
|
+
required :status, String
|
|
104
|
+
|
|
105
|
+
# @!method initialize(completion_time:, created_at:, invoice_id:, modified_at:, start_time:, status:)
|
|
106
|
+
# @param completion_time [Time, nil]
|
|
107
|
+
# @param created_at [Time, nil]
|
|
108
|
+
# @param invoice_id [String]
|
|
109
|
+
# @param modified_at [Time, nil]
|
|
110
|
+
# @param start_time [Time, nil]
|
|
111
|
+
# @param status [String]
|
|
112
|
+
end
|
|
113
|
+
|
|
114
|
+
class DunningStep < Orb::Internal::Type::BaseModel
|
|
115
|
+
# @!attribute actions
|
|
116
|
+
#
|
|
117
|
+
# @return [Array<String>]
|
|
118
|
+
required :actions, Orb::Internal::Type::ArrayOf[String]
|
|
119
|
+
|
|
120
|
+
# @!attribute created_at
|
|
121
|
+
#
|
|
122
|
+
# @return [Time, nil]
|
|
123
|
+
required :created_at, Time, nil?: true
|
|
124
|
+
|
|
125
|
+
# @!attribute execution_time
|
|
126
|
+
#
|
|
127
|
+
# @return [Time, nil]
|
|
128
|
+
required :execution_time, Time, nil?: true
|
|
129
|
+
|
|
130
|
+
# @!attribute manually_triggered_at
|
|
131
|
+
#
|
|
132
|
+
# @return [Time, nil]
|
|
133
|
+
required :manually_triggered_at, Time, nil?: true
|
|
134
|
+
|
|
135
|
+
# @!attribute modified_at
|
|
136
|
+
#
|
|
137
|
+
# @return [Time, nil]
|
|
138
|
+
required :modified_at, Time, nil?: true
|
|
139
|
+
|
|
140
|
+
# @!attribute status
|
|
141
|
+
#
|
|
142
|
+
# @return [String]
|
|
143
|
+
required :status, String
|
|
144
|
+
|
|
145
|
+
# @!attribute step_number
|
|
146
|
+
#
|
|
147
|
+
# @return [Integer, nil]
|
|
148
|
+
required :step_number, Integer, nil?: true
|
|
149
|
+
|
|
150
|
+
# @!attribute timestamp
|
|
151
|
+
#
|
|
152
|
+
# @return [Time, nil]
|
|
153
|
+
required :timestamp, Time, nil?: true
|
|
154
|
+
|
|
155
|
+
# @!method initialize(actions:, created_at:, execution_time:, manually_triggered_at:, modified_at:, status:, step_number:, timestamp:)
|
|
156
|
+
# @param actions [Array<String>]
|
|
157
|
+
# @param created_at [Time, nil]
|
|
158
|
+
# @param execution_time [Time, nil]
|
|
159
|
+
# @param manually_triggered_at [Time, nil]
|
|
160
|
+
# @param modified_at [Time, nil]
|
|
161
|
+
# @param status [String]
|
|
162
|
+
# @param step_number [Integer, nil]
|
|
163
|
+
# @param timestamp [Time, nil]
|
|
164
|
+
end
|
|
165
|
+
end
|
|
166
|
+
|
|
167
|
+
# The event this payload describes.
|
|
168
|
+
#
|
|
169
|
+
# @see Orb::Models::InvoiceDunningScheduleEndedWebhookEvent#type
|
|
170
|
+
module Type
|
|
171
|
+
extend Orb::Internal::Type::Enum
|
|
172
|
+
|
|
173
|
+
INVOICE_DUNNING_SCHEDULE_ENDED = :"invoice.dunning_schedule_ended"
|
|
174
|
+
|
|
175
|
+
# @!method self.values
|
|
176
|
+
# @return [Array<Symbol>]
|
|
177
|
+
end
|
|
178
|
+
end
|
|
179
|
+
end
|
|
180
|
+
end
|
|
@@ -0,0 +1,184 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Orb
|
|
4
|
+
module Models
|
|
5
|
+
class InvoiceDunningScheduleResetWebhookEvent < Orb::Internal::Type::BaseModel
|
|
6
|
+
# @!attribute id
|
|
7
|
+
# The ID of this webhook event.
|
|
8
|
+
#
|
|
9
|
+
# @return [String]
|
|
10
|
+
required :id, String
|
|
11
|
+
|
|
12
|
+
# @!attribute created_at
|
|
13
|
+
# The time at which this event was created, to the second.
|
|
14
|
+
#
|
|
15
|
+
# @return [Time]
|
|
16
|
+
required :created_at, Time
|
|
17
|
+
|
|
18
|
+
# @!attribute invoice
|
|
19
|
+
# An [`Invoice`](/core-concepts#invoice) is a fundamental billing entity,
|
|
20
|
+
# representing the request for payment for a single subscription. This includes a
|
|
21
|
+
# set of line items, which correspond to prices in the subscription's plan and can
|
|
22
|
+
# represent fixed recurring fees or usage-based fees. They are generated at the
|
|
23
|
+
# end of a billing period, or as the result of an action, such as a cancellation.
|
|
24
|
+
#
|
|
25
|
+
# @return [Orb::Models::Invoice]
|
|
26
|
+
required :invoice, -> { Orb::Invoice }
|
|
27
|
+
|
|
28
|
+
# @!attribute properties
|
|
29
|
+
#
|
|
30
|
+
# @return [Orb::Models::InvoiceDunningScheduleResetWebhookEvent::Properties]
|
|
31
|
+
required :properties, -> { Orb::InvoiceDunningScheduleResetWebhookEvent::Properties }
|
|
32
|
+
|
|
33
|
+
# @!attribute type
|
|
34
|
+
# The event this payload describes.
|
|
35
|
+
#
|
|
36
|
+
# @return [Symbol, Orb::Models::InvoiceDunningScheduleResetWebhookEvent::Type]
|
|
37
|
+
required :type, enum: -> { Orb::InvoiceDunningScheduleResetWebhookEvent::Type }
|
|
38
|
+
|
|
39
|
+
# @!method initialize(id:, created_at:, invoice:, properties:, type:)
|
|
40
|
+
# Some parameter documentations has been truncated, see
|
|
41
|
+
# {Orb::Models::InvoiceDunningScheduleResetWebhookEvent} for more details.
|
|
42
|
+
#
|
|
43
|
+
# Issued when a dunning schedule is reset.
|
|
44
|
+
#
|
|
45
|
+
# @param id [String] The ID of this webhook event.
|
|
46
|
+
#
|
|
47
|
+
# @param created_at [Time] The time at which this event was created, to the second.
|
|
48
|
+
#
|
|
49
|
+
# @param invoice [Orb::Models::Invoice] An [`Invoice`](/core-concepts#invoice) is a fundamental billing entity, represen
|
|
50
|
+
#
|
|
51
|
+
# @param properties [Orb::Models::InvoiceDunningScheduleResetWebhookEvent::Properties]
|
|
52
|
+
#
|
|
53
|
+
# @param type [Symbol, Orb::Models::InvoiceDunningScheduleResetWebhookEvent::Type] The event this payload describes.
|
|
54
|
+
|
|
55
|
+
# @see Orb::Models::InvoiceDunningScheduleResetWebhookEvent#properties
|
|
56
|
+
class Properties < Orb::Internal::Type::BaseModel
|
|
57
|
+
# @!attribute dunning_schedule
|
|
58
|
+
# The schedule shape `DunningScheduleV2.external_serialization()` produces, which
|
|
59
|
+
# is narrower than the schedule's api resource.
|
|
60
|
+
#
|
|
61
|
+
# @return [Orb::Models::InvoiceDunningScheduleResetWebhookEvent::Properties::DunningSchedule]
|
|
62
|
+
required :dunning_schedule,
|
|
63
|
+
-> { Orb::InvoiceDunningScheduleResetWebhookEvent::Properties::DunningSchedule }
|
|
64
|
+
|
|
65
|
+
# @!attribute previous_schedule
|
|
66
|
+
# The schedule shape `DunningScheduleV2.external_serialization()` produces, which
|
|
67
|
+
# is narrower than the schedule's api resource.
|
|
68
|
+
#
|
|
69
|
+
# @return [Orb::Models::InvoiceDunningScheduleResetWebhookEvent::Properties::PreviousSchedule]
|
|
70
|
+
required :previous_schedule,
|
|
71
|
+
-> { Orb::InvoiceDunningScheduleResetWebhookEvent::Properties::PreviousSchedule }
|
|
72
|
+
|
|
73
|
+
# @!method initialize(dunning_schedule:, previous_schedule:)
|
|
74
|
+
# Some parameter documentations has been truncated, see
|
|
75
|
+
# {Orb::Models::InvoiceDunningScheduleResetWebhookEvent::Properties} for more
|
|
76
|
+
# details.
|
|
77
|
+
#
|
|
78
|
+
# @param dunning_schedule [Orb::Models::InvoiceDunningScheduleResetWebhookEvent::Properties::DunningSchedule] The schedule shape `DunningScheduleV2.external_serialization()` produces, which
|
|
79
|
+
#
|
|
80
|
+
# @param previous_schedule [Orb::Models::InvoiceDunningScheduleResetWebhookEvent::Properties::PreviousSchedule] The schedule shape `DunningScheduleV2.external_serialization()` produces, which
|
|
81
|
+
|
|
82
|
+
# @see Orb::Models::InvoiceDunningScheduleResetWebhookEvent::Properties#dunning_schedule
|
|
83
|
+
class DunningSchedule < Orb::Internal::Type::BaseModel
|
|
84
|
+
# @!attribute completion_time
|
|
85
|
+
#
|
|
86
|
+
# @return [Time, nil]
|
|
87
|
+
required :completion_time, Time, nil?: true
|
|
88
|
+
|
|
89
|
+
# @!attribute created_at
|
|
90
|
+
#
|
|
91
|
+
# @return [Time, nil]
|
|
92
|
+
required :created_at, Time, nil?: true
|
|
93
|
+
|
|
94
|
+
# @!attribute invoice_id
|
|
95
|
+
#
|
|
96
|
+
# @return [String]
|
|
97
|
+
required :invoice_id, String
|
|
98
|
+
|
|
99
|
+
# @!attribute modified_at
|
|
100
|
+
#
|
|
101
|
+
# @return [Time, nil]
|
|
102
|
+
required :modified_at, Time, nil?: true
|
|
103
|
+
|
|
104
|
+
# @!attribute start_time
|
|
105
|
+
#
|
|
106
|
+
# @return [Time, nil]
|
|
107
|
+
required :start_time, Time, nil?: true
|
|
108
|
+
|
|
109
|
+
# @!attribute status
|
|
110
|
+
#
|
|
111
|
+
# @return [String, nil]
|
|
112
|
+
required :status, String, nil?: true
|
|
113
|
+
|
|
114
|
+
# @!method initialize(completion_time:, created_at:, invoice_id:, modified_at:, start_time:, status:)
|
|
115
|
+
# The schedule shape `DunningScheduleV2.external_serialization()` produces, which
|
|
116
|
+
# is narrower than the schedule's api resource.
|
|
117
|
+
#
|
|
118
|
+
# @param completion_time [Time, nil]
|
|
119
|
+
# @param created_at [Time, nil]
|
|
120
|
+
# @param invoice_id [String]
|
|
121
|
+
# @param modified_at [Time, nil]
|
|
122
|
+
# @param start_time [Time, nil]
|
|
123
|
+
# @param status [String, nil]
|
|
124
|
+
end
|
|
125
|
+
|
|
126
|
+
# @see Orb::Models::InvoiceDunningScheduleResetWebhookEvent::Properties#previous_schedule
|
|
127
|
+
class PreviousSchedule < Orb::Internal::Type::BaseModel
|
|
128
|
+
# @!attribute completion_time
|
|
129
|
+
#
|
|
130
|
+
# @return [Time, nil]
|
|
131
|
+
required :completion_time, Time, nil?: true
|
|
132
|
+
|
|
133
|
+
# @!attribute created_at
|
|
134
|
+
#
|
|
135
|
+
# @return [Time, nil]
|
|
136
|
+
required :created_at, Time, nil?: true
|
|
137
|
+
|
|
138
|
+
# @!attribute invoice_id
|
|
139
|
+
#
|
|
140
|
+
# @return [String]
|
|
141
|
+
required :invoice_id, String
|
|
142
|
+
|
|
143
|
+
# @!attribute modified_at
|
|
144
|
+
#
|
|
145
|
+
# @return [Time, nil]
|
|
146
|
+
required :modified_at, Time, nil?: true
|
|
147
|
+
|
|
148
|
+
# @!attribute start_time
|
|
149
|
+
#
|
|
150
|
+
# @return [Time, nil]
|
|
151
|
+
required :start_time, Time, nil?: true
|
|
152
|
+
|
|
153
|
+
# @!attribute status
|
|
154
|
+
#
|
|
155
|
+
# @return [String, nil]
|
|
156
|
+
required :status, String, nil?: true
|
|
157
|
+
|
|
158
|
+
# @!method initialize(completion_time:, created_at:, invoice_id:, modified_at:, start_time:, status:)
|
|
159
|
+
# The schedule shape `DunningScheduleV2.external_serialization()` produces, which
|
|
160
|
+
# is narrower than the schedule's api resource.
|
|
161
|
+
#
|
|
162
|
+
# @param completion_time [Time, nil]
|
|
163
|
+
# @param created_at [Time, nil]
|
|
164
|
+
# @param invoice_id [String]
|
|
165
|
+
# @param modified_at [Time, nil]
|
|
166
|
+
# @param start_time [Time, nil]
|
|
167
|
+
# @param status [String, nil]
|
|
168
|
+
end
|
|
169
|
+
end
|
|
170
|
+
|
|
171
|
+
# The event this payload describes.
|
|
172
|
+
#
|
|
173
|
+
# @see Orb::Models::InvoiceDunningScheduleResetWebhookEvent#type
|
|
174
|
+
module Type
|
|
175
|
+
extend Orb::Internal::Type::Enum
|
|
176
|
+
|
|
177
|
+
INVOICE_DUNNING_SCHEDULE_RESET = :"invoice.dunning_schedule_reset"
|
|
178
|
+
|
|
179
|
+
# @!method self.values
|
|
180
|
+
# @return [Array<Symbol>]
|
|
181
|
+
end
|
|
182
|
+
end
|
|
183
|
+
end
|
|
184
|
+
end
|
|
@@ -0,0 +1,133 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Orb
|
|
4
|
+
module Models
|
|
5
|
+
class InvoiceDunningScheduleStepExecutedWebhookEvent < Orb::Internal::Type::BaseModel
|
|
6
|
+
# @!attribute id
|
|
7
|
+
# The ID of this webhook event.
|
|
8
|
+
#
|
|
9
|
+
# @return [String]
|
|
10
|
+
required :id, String
|
|
11
|
+
|
|
12
|
+
# @!attribute created_at
|
|
13
|
+
# The time at which this event was created, to the second.
|
|
14
|
+
#
|
|
15
|
+
# @return [Time]
|
|
16
|
+
required :created_at, Time
|
|
17
|
+
|
|
18
|
+
# @!attribute invoice
|
|
19
|
+
# An [`Invoice`](/core-concepts#invoice) is a fundamental billing entity,
|
|
20
|
+
# representing the request for payment for a single subscription. This includes a
|
|
21
|
+
# set of line items, which correspond to prices in the subscription's plan and can
|
|
22
|
+
# represent fixed recurring fees or usage-based fees. They are generated at the
|
|
23
|
+
# end of a billing period, or as the result of an action, such as a cancellation.
|
|
24
|
+
#
|
|
25
|
+
# @return [Orb::Models::Invoice]
|
|
26
|
+
required :invoice, -> { Orb::Invoice }
|
|
27
|
+
|
|
28
|
+
# @!attribute properties
|
|
29
|
+
#
|
|
30
|
+
# @return [Orb::Models::InvoiceDunningScheduleStepExecutedWebhookEvent::Properties]
|
|
31
|
+
required :properties, -> { Orb::InvoiceDunningScheduleStepExecutedWebhookEvent::Properties }
|
|
32
|
+
|
|
33
|
+
# @!attribute type
|
|
34
|
+
# The event this payload describes.
|
|
35
|
+
#
|
|
36
|
+
# @return [Symbol, Orb::Models::InvoiceDunningScheduleStepExecutedWebhookEvent::Type]
|
|
37
|
+
required :type, enum: -> { Orb::InvoiceDunningScheduleStepExecutedWebhookEvent::Type }
|
|
38
|
+
|
|
39
|
+
# @!method initialize(id:, created_at:, invoice:, properties:, type:)
|
|
40
|
+
# Some parameter documentations has been truncated, see
|
|
41
|
+
# {Orb::Models::InvoiceDunningScheduleStepExecutedWebhookEvent} for more details.
|
|
42
|
+
#
|
|
43
|
+
# Issued when a dunning schedule step is executed.
|
|
44
|
+
#
|
|
45
|
+
# @param id [String] The ID of this webhook event.
|
|
46
|
+
#
|
|
47
|
+
# @param created_at [Time] The time at which this event was created, to the second.
|
|
48
|
+
#
|
|
49
|
+
# @param invoice [Orb::Models::Invoice] An [`Invoice`](/core-concepts#invoice) is a fundamental billing entity, represen
|
|
50
|
+
#
|
|
51
|
+
# @param properties [Orb::Models::InvoiceDunningScheduleStepExecutedWebhookEvent::Properties]
|
|
52
|
+
#
|
|
53
|
+
# @param type [Symbol, Orb::Models::InvoiceDunningScheduleStepExecutedWebhookEvent::Type] The event this payload describes.
|
|
54
|
+
|
|
55
|
+
# @see Orb::Models::InvoiceDunningScheduleStepExecutedWebhookEvent#properties
|
|
56
|
+
class Properties < Orb::Internal::Type::BaseModel
|
|
57
|
+
# @!attribute dunning_step
|
|
58
|
+
#
|
|
59
|
+
# @return [Orb::Models::InvoiceDunningScheduleStepExecutedWebhookEvent::Properties::DunningStep]
|
|
60
|
+
required :dunning_step,
|
|
61
|
+
-> { Orb::InvoiceDunningScheduleStepExecutedWebhookEvent::Properties::DunningStep }
|
|
62
|
+
|
|
63
|
+
# @!method initialize(dunning_step:)
|
|
64
|
+
# @param dunning_step [Orb::Models::InvoiceDunningScheduleStepExecutedWebhookEvent::Properties::DunningStep]
|
|
65
|
+
|
|
66
|
+
# @see Orb::Models::InvoiceDunningScheduleStepExecutedWebhookEvent::Properties#dunning_step
|
|
67
|
+
class DunningStep < Orb::Internal::Type::BaseModel
|
|
68
|
+
# @!attribute actions
|
|
69
|
+
#
|
|
70
|
+
# @return [Array<String>]
|
|
71
|
+
required :actions, Orb::Internal::Type::ArrayOf[String]
|
|
72
|
+
|
|
73
|
+
# @!attribute created_at
|
|
74
|
+
#
|
|
75
|
+
# @return [Time, nil]
|
|
76
|
+
required :created_at, Time, nil?: true
|
|
77
|
+
|
|
78
|
+
# @!attribute execution_time
|
|
79
|
+
#
|
|
80
|
+
# @return [Time, nil]
|
|
81
|
+
required :execution_time, Time, nil?: true
|
|
82
|
+
|
|
83
|
+
# @!attribute manually_triggered_at
|
|
84
|
+
#
|
|
85
|
+
# @return [Time, nil]
|
|
86
|
+
required :manually_triggered_at, Time, nil?: true
|
|
87
|
+
|
|
88
|
+
# @!attribute modified_at
|
|
89
|
+
#
|
|
90
|
+
# @return [Time, nil]
|
|
91
|
+
required :modified_at, Time, nil?: true
|
|
92
|
+
|
|
93
|
+
# @!attribute status
|
|
94
|
+
#
|
|
95
|
+
# @return [String]
|
|
96
|
+
required :status, String
|
|
97
|
+
|
|
98
|
+
# @!attribute step_number
|
|
99
|
+
#
|
|
100
|
+
# @return [Integer, nil]
|
|
101
|
+
required :step_number, Integer, nil?: true
|
|
102
|
+
|
|
103
|
+
# @!attribute timestamp
|
|
104
|
+
#
|
|
105
|
+
# @return [Time, nil]
|
|
106
|
+
required :timestamp, Time, nil?: true
|
|
107
|
+
|
|
108
|
+
# @!method initialize(actions:, created_at:, execution_time:, manually_triggered_at:, modified_at:, status:, step_number:, timestamp:)
|
|
109
|
+
# @param actions [Array<String>]
|
|
110
|
+
# @param created_at [Time, nil]
|
|
111
|
+
# @param execution_time [Time, nil]
|
|
112
|
+
# @param manually_triggered_at [Time, nil]
|
|
113
|
+
# @param modified_at [Time, nil]
|
|
114
|
+
# @param status [String]
|
|
115
|
+
# @param step_number [Integer, nil]
|
|
116
|
+
# @param timestamp [Time, nil]
|
|
117
|
+
end
|
|
118
|
+
end
|
|
119
|
+
|
|
120
|
+
# The event this payload describes.
|
|
121
|
+
#
|
|
122
|
+
# @see Orb::Models::InvoiceDunningScheduleStepExecutedWebhookEvent#type
|
|
123
|
+
module Type
|
|
124
|
+
extend Orb::Internal::Type::Enum
|
|
125
|
+
|
|
126
|
+
INVOICE_DUNNING_SCHEDULE_STEP_EXECUTED = :"invoice.dunning_schedule_step_executed"
|
|
127
|
+
|
|
128
|
+
# @!method self.values
|
|
129
|
+
# @return [Array<Symbol>]
|
|
130
|
+
end
|
|
131
|
+
end
|
|
132
|
+
end
|
|
133
|
+
end
|