orb-billing 1.35.0 → 1.36.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 +18 -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,105 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Orb
|
|
4
|
+
module Models
|
|
5
|
+
class PriceEditedWebhookEvent < 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 price
|
|
19
|
+
# The Price resource represents a price that can be billed on a subscription,
|
|
20
|
+
# resulting in a charge on an invoice in the form of an invoice line item. Prices
|
|
21
|
+
# take a quantity and determine an amount to bill.
|
|
22
|
+
#
|
|
23
|
+
# Orb supports a few different pricing models out of the box. Each of these models
|
|
24
|
+
# is serialized differently in a given Price object. The model_type field
|
|
25
|
+
# determines the key for the configuration object that is present.
|
|
26
|
+
#
|
|
27
|
+
# For more on the types of prices, see
|
|
28
|
+
# [the core concepts documentation](/core-concepts#plan-and-price)
|
|
29
|
+
#
|
|
30
|
+
# @return [Orb::Models::Price::Unit, Orb::Models::Price::Tiered, Orb::Models::Price::Bulk, Orb::Models::Price::BulkWithFilters, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::GroupedTiered, Orb::Models::Price::GroupedTieredMatrix, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredMatrixWithAllocation, Orb::Models::Price::MatrixWithThresholdDiscounts, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::GroupedWithMinMaxThresholds, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk, Orb::Models::Price::CumulativeGroupedAllocation, Orb::Models::Price::DailyCreditAllowance, Orb::Models::Price::MeteredAllowance, Orb::Models::Price::MinimumComposite, Orb::Models::Price::Percent, Orb::Models::Price::EventOutput]
|
|
31
|
+
required :price, union: -> { Orb::Price }
|
|
32
|
+
|
|
33
|
+
# @!attribute properties
|
|
34
|
+
#
|
|
35
|
+
# @return [Orb::Models::PriceEditedWebhookEvent::Properties]
|
|
36
|
+
required :properties, -> { Orb::PriceEditedWebhookEvent::Properties }
|
|
37
|
+
|
|
38
|
+
# @!attribute type
|
|
39
|
+
# The event this payload describes.
|
|
40
|
+
#
|
|
41
|
+
# @return [Symbol, Orb::Models::PriceEditedWebhookEvent::Type]
|
|
42
|
+
required :type, enum: -> { Orb::PriceEditedWebhookEvent::Type }
|
|
43
|
+
|
|
44
|
+
# @!method initialize(id:, created_at:, price:, properties:, type:)
|
|
45
|
+
# Some parameter documentations has been truncated, see
|
|
46
|
+
# {Orb::Models::PriceEditedWebhookEvent} for more details.
|
|
47
|
+
#
|
|
48
|
+
# Issued when a price is edited.
|
|
49
|
+
#
|
|
50
|
+
# @param id [String] The ID of this webhook event.
|
|
51
|
+
#
|
|
52
|
+
# @param created_at [Time] The time at which this event was created, to the second.
|
|
53
|
+
#
|
|
54
|
+
# @param price [Orb::Models::Price::Unit, Orb::Models::Price::Tiered, Orb::Models::Price::Bulk, Orb::Models::Price::BulkWithFilters, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::GroupedTiered, Orb::Models::Price::GroupedTieredMatrix, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredMatrixWithAllocation, Orb::Models::Price::MatrixWithThresholdDiscounts, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::GroupedWithMinMaxThresholds, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk, Orb::Models::Price::CumulativeGroupedAllocation, Orb::Models::Price::DailyCreditAllowance, Orb::Models::Price::MeteredAllowance, Orb::Models::Price::MinimumComposite, Orb::Models::Price::Percent, Orb::Models::Price::EventOutput] The Price resource represents a price that can be billed on a subscription, resu
|
|
55
|
+
#
|
|
56
|
+
# @param properties [Orb::Models::PriceEditedWebhookEvent::Properties]
|
|
57
|
+
#
|
|
58
|
+
# @param type [Symbol, Orb::Models::PriceEditedWebhookEvent::Type] The event this payload describes.
|
|
59
|
+
|
|
60
|
+
# @see Orb::Models::PriceEditedWebhookEvent#properties
|
|
61
|
+
class Properties < Orb::Internal::Type::BaseModel
|
|
62
|
+
# @!attribute previous_attributes
|
|
63
|
+
# metadata values are non-null on the wire (deleting a key removes it from
|
|
64
|
+
# storage); the Optional[str] values only exist on the new half of a metadata
|
|
65
|
+
# FieldChange.
|
|
66
|
+
#
|
|
67
|
+
# @return [Orb::Models::PriceEditedWebhookEvent::Properties::PreviousAttributes]
|
|
68
|
+
required :previous_attributes, -> { Orb::PriceEditedWebhookEvent::Properties::PreviousAttributes }
|
|
69
|
+
|
|
70
|
+
# @!method initialize(previous_attributes:)
|
|
71
|
+
# Some parameter documentations has been truncated, see
|
|
72
|
+
# {Orb::Models::PriceEditedWebhookEvent::Properties} for more details.
|
|
73
|
+
#
|
|
74
|
+
# @param previous_attributes [Orb::Models::PriceEditedWebhookEvent::Properties::PreviousAttributes] metadata values are non-null on the wire (deleting a key removes it from storage
|
|
75
|
+
|
|
76
|
+
# @see Orb::Models::PriceEditedWebhookEvent::Properties#previous_attributes
|
|
77
|
+
class PreviousAttributes < Orb::Internal::Type::BaseModel
|
|
78
|
+
# @!attribute metadata
|
|
79
|
+
#
|
|
80
|
+
# @return [Hash{Symbol=>String}, nil]
|
|
81
|
+
optional :metadata, Orb::Internal::Type::HashOf[String], nil?: true
|
|
82
|
+
|
|
83
|
+
# @!method initialize(metadata: nil)
|
|
84
|
+
# metadata values are non-null on the wire (deleting a key removes it from
|
|
85
|
+
# storage); the Optional[str] values only exist on the new half of a metadata
|
|
86
|
+
# FieldChange.
|
|
87
|
+
#
|
|
88
|
+
# @param metadata [Hash{Symbol=>String}, nil]
|
|
89
|
+
end
|
|
90
|
+
end
|
|
91
|
+
|
|
92
|
+
# The event this payload describes.
|
|
93
|
+
#
|
|
94
|
+
# @see Orb::Models::PriceEditedWebhookEvent#type
|
|
95
|
+
module Type
|
|
96
|
+
extend Orb::Internal::Type::Enum
|
|
97
|
+
|
|
98
|
+
PRICE_EDITED = :"price.edited"
|
|
99
|
+
|
|
100
|
+
# @!method self.values
|
|
101
|
+
# @return [Array<Symbol>]
|
|
102
|
+
end
|
|
103
|
+
end
|
|
104
|
+
end
|
|
105
|
+
end
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Orb
|
|
4
|
+
module Models
|
|
5
|
+
class ResourceEventTestWebhookEvent < 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 properties
|
|
19
|
+
#
|
|
20
|
+
# @return [Orb::Models::ResourceEventTestWebhookEvent::Properties]
|
|
21
|
+
required :properties, -> { Orb::ResourceEventTestWebhookEvent::Properties }
|
|
22
|
+
|
|
23
|
+
# @!attribute type
|
|
24
|
+
# The event this payload describes.
|
|
25
|
+
#
|
|
26
|
+
# @return [Symbol, Orb::Models::ResourceEventTestWebhookEvent::Type]
|
|
27
|
+
required :type, enum: -> { Orb::ResourceEventTestWebhookEvent::Type }
|
|
28
|
+
|
|
29
|
+
# @!method initialize(id:, created_at:, properties:, type:)
|
|
30
|
+
# Issued when a test webhook is sent.
|
|
31
|
+
#
|
|
32
|
+
# @param id [String] The ID of this webhook event.
|
|
33
|
+
#
|
|
34
|
+
# @param created_at [Time] The time at which this event was created, to the second.
|
|
35
|
+
#
|
|
36
|
+
# @param properties [Orb::Models::ResourceEventTestWebhookEvent::Properties]
|
|
37
|
+
#
|
|
38
|
+
# @param type [Symbol, Orb::Models::ResourceEventTestWebhookEvent::Type] The event this payload describes.
|
|
39
|
+
|
|
40
|
+
# @see Orb::Models::ResourceEventTestWebhookEvent#properties
|
|
41
|
+
class Properties < Orb::Internal::Type::BaseModel
|
|
42
|
+
# @!attribute message
|
|
43
|
+
#
|
|
44
|
+
# @return [String, nil]
|
|
45
|
+
optional :message, String
|
|
46
|
+
|
|
47
|
+
# @!method initialize(message: nil)
|
|
48
|
+
# @param message [String]
|
|
49
|
+
end
|
|
50
|
+
|
|
51
|
+
# The event this payload describes.
|
|
52
|
+
#
|
|
53
|
+
# @see Orb::Models::ResourceEventTestWebhookEvent#type
|
|
54
|
+
module Type
|
|
55
|
+
extend Orb::Internal::Type::Enum
|
|
56
|
+
|
|
57
|
+
RESOURCE_EVENT_TEST = :"resource_event.test"
|
|
58
|
+
|
|
59
|
+
# @!method self.values
|
|
60
|
+
# @return [Array<Symbol>]
|
|
61
|
+
end
|
|
62
|
+
end
|
|
63
|
+
end
|
|
64
|
+
end
|
|
@@ -0,0 +1,164 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Orb
|
|
4
|
+
module Models
|
|
5
|
+
class SalesOrderAccountingSyncFailedWebhookEvent < 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 accounting_sync_record
|
|
13
|
+
#
|
|
14
|
+
# @return [Orb::Models::SalesOrderAccountingSyncFailedWebhookEvent::AccountingSyncRecord]
|
|
15
|
+
required :accounting_sync_record,
|
|
16
|
+
-> { Orb::SalesOrderAccountingSyncFailedWebhookEvent::AccountingSyncRecord }
|
|
17
|
+
|
|
18
|
+
# @!attribute created_at
|
|
19
|
+
# The time at which this event was created, to the second.
|
|
20
|
+
#
|
|
21
|
+
# @return [Time]
|
|
22
|
+
required :created_at, Time
|
|
23
|
+
|
|
24
|
+
# @!attribute invoice
|
|
25
|
+
# An [`Invoice`](/core-concepts#invoice) is a fundamental billing entity,
|
|
26
|
+
# representing the request for payment for a single subscription. This includes a
|
|
27
|
+
# set of line items, which correspond to prices in the subscription's plan and can
|
|
28
|
+
# represent fixed recurring fees or usage-based fees. They are generated at the
|
|
29
|
+
# end of a billing period, or as the result of an action, such as a cancellation.
|
|
30
|
+
#
|
|
31
|
+
# @return [Orb::Models::Invoice]
|
|
32
|
+
required :invoice, -> { Orb::Invoice }
|
|
33
|
+
|
|
34
|
+
# @!attribute properties
|
|
35
|
+
#
|
|
36
|
+
# @return [Orb::Models::SalesOrderAccountingSyncFailedWebhookEvent::Properties]
|
|
37
|
+
required :properties, -> { Orb::SalesOrderAccountingSyncFailedWebhookEvent::Properties }
|
|
38
|
+
|
|
39
|
+
# @!attribute type
|
|
40
|
+
# The event this payload describes.
|
|
41
|
+
#
|
|
42
|
+
# @return [Symbol, Orb::Models::SalesOrderAccountingSyncFailedWebhookEvent::Type]
|
|
43
|
+
required :type, enum: -> { Orb::SalesOrderAccountingSyncFailedWebhookEvent::Type }
|
|
44
|
+
|
|
45
|
+
# @!method initialize(id:, accounting_sync_record:, created_at:, invoice:, properties:, type:)
|
|
46
|
+
# Some parameter documentations has been truncated, see
|
|
47
|
+
# {Orb::Models::SalesOrderAccountingSyncFailedWebhookEvent} for more details.
|
|
48
|
+
#
|
|
49
|
+
# Issued when a sales order accounting sync fails.
|
|
50
|
+
#
|
|
51
|
+
# @param id [String] The ID of this webhook event.
|
|
52
|
+
#
|
|
53
|
+
# @param accounting_sync_record [Orb::Models::SalesOrderAccountingSyncFailedWebhookEvent::AccountingSyncRecord]
|
|
54
|
+
#
|
|
55
|
+
# @param created_at [Time] The time at which this event was created, to the second.
|
|
56
|
+
#
|
|
57
|
+
# @param invoice [Orb::Models::Invoice] An [`Invoice`](/core-concepts#invoice) is a fundamental billing entity, represen
|
|
58
|
+
#
|
|
59
|
+
# @param properties [Orb::Models::SalesOrderAccountingSyncFailedWebhookEvent::Properties]
|
|
60
|
+
#
|
|
61
|
+
# @param type [Symbol, Orb::Models::SalesOrderAccountingSyncFailedWebhookEvent::Type] The event this payload describes.
|
|
62
|
+
|
|
63
|
+
# @see Orb::Models::SalesOrderAccountingSyncFailedWebhookEvent#accounting_sync_record
|
|
64
|
+
class AccountingSyncRecord < Orb::Internal::Type::BaseModel
|
|
65
|
+
# @!attribute id
|
|
66
|
+
#
|
|
67
|
+
# @return [String]
|
|
68
|
+
required :id, String
|
|
69
|
+
|
|
70
|
+
# @!attribute customer_id
|
|
71
|
+
#
|
|
72
|
+
# @return [String]
|
|
73
|
+
required :customer_id, String
|
|
74
|
+
|
|
75
|
+
# @!attribute record_type
|
|
76
|
+
#
|
|
77
|
+
# @return [Symbol, Orb::Models::SalesOrderAccountingSyncFailedWebhookEvent::AccountingSyncRecord::RecordType]
|
|
78
|
+
required :record_type,
|
|
79
|
+
enum: -> { Orb::SalesOrderAccountingSyncFailedWebhookEvent::AccountingSyncRecord::RecordType }
|
|
80
|
+
|
|
81
|
+
# @!attribute error_details
|
|
82
|
+
#
|
|
83
|
+
# @return [Hash{Symbol=>Object}, nil]
|
|
84
|
+
optional :error_details, Orb::Internal::Type::HashOf[Orb::Internal::Type::Unknown], nil?: true
|
|
85
|
+
|
|
86
|
+
# @!attribute invoice_id
|
|
87
|
+
#
|
|
88
|
+
# @return [String, nil]
|
|
89
|
+
optional :invoice_id, String, nil?: true
|
|
90
|
+
|
|
91
|
+
# @!attribute provider_customer_id
|
|
92
|
+
#
|
|
93
|
+
# @return [String, nil]
|
|
94
|
+
optional :provider_customer_id, String, nil?: true
|
|
95
|
+
|
|
96
|
+
# @!attribute status
|
|
97
|
+
#
|
|
98
|
+
# @return [String, nil]
|
|
99
|
+
optional :status, String, nil?: true
|
|
100
|
+
|
|
101
|
+
# @!attribute sync_action
|
|
102
|
+
#
|
|
103
|
+
# @return [String, nil]
|
|
104
|
+
optional :sync_action, String, nil?: true
|
|
105
|
+
|
|
106
|
+
# @!method initialize(id:, customer_id:, record_type:, error_details: nil, invoice_id: nil, provider_customer_id: nil, status: nil, sync_action: nil)
|
|
107
|
+
# @param id [String]
|
|
108
|
+
# @param customer_id [String]
|
|
109
|
+
# @param record_type [Symbol, Orb::Models::SalesOrderAccountingSyncFailedWebhookEvent::AccountingSyncRecord::RecordType]
|
|
110
|
+
# @param error_details [Hash{Symbol=>Object}, nil]
|
|
111
|
+
# @param invoice_id [String, nil]
|
|
112
|
+
# @param provider_customer_id [String, nil]
|
|
113
|
+
# @param status [String, nil]
|
|
114
|
+
# @param sync_action [String, nil]
|
|
115
|
+
|
|
116
|
+
# @see Orb::Models::SalesOrderAccountingSyncFailedWebhookEvent::AccountingSyncRecord#record_type
|
|
117
|
+
module RecordType
|
|
118
|
+
extend Orb::Internal::Type::Enum
|
|
119
|
+
|
|
120
|
+
CUSTOMER = :customer
|
|
121
|
+
INVOICE = :invoice
|
|
122
|
+
TRANSACTION = :transaction
|
|
123
|
+
CUSTOMER_BALANCE_TRANSACTION = :customer_balance_transaction
|
|
124
|
+
CREDIT_NOTE = :credit_note
|
|
125
|
+
SUBSCRIPTION = :subscription
|
|
126
|
+
SALES_ORDER = :sales_order
|
|
127
|
+
BLOCK = :block
|
|
128
|
+
|
|
129
|
+
# @!method self.values
|
|
130
|
+
# @return [Array<Symbol>]
|
|
131
|
+
end
|
|
132
|
+
end
|
|
133
|
+
|
|
134
|
+
# @see Orb::Models::SalesOrderAccountingSyncFailedWebhookEvent#properties
|
|
135
|
+
class Properties < Orb::Internal::Type::BaseModel
|
|
136
|
+
# @!attribute connection_type
|
|
137
|
+
#
|
|
138
|
+
# @return [String]
|
|
139
|
+
required :connection_type, String
|
|
140
|
+
|
|
141
|
+
# @!attribute failure_reason
|
|
142
|
+
#
|
|
143
|
+
# @return [String]
|
|
144
|
+
required :failure_reason, String
|
|
145
|
+
|
|
146
|
+
# @!method initialize(connection_type:, failure_reason:)
|
|
147
|
+
# @param connection_type [String]
|
|
148
|
+
# @param failure_reason [String]
|
|
149
|
+
end
|
|
150
|
+
|
|
151
|
+
# The event this payload describes.
|
|
152
|
+
#
|
|
153
|
+
# @see Orb::Models::SalesOrderAccountingSyncFailedWebhookEvent#type
|
|
154
|
+
module Type
|
|
155
|
+
extend Orb::Internal::Type::Enum
|
|
156
|
+
|
|
157
|
+
SALES_ORDER_ACCOUNTING_SYNC_FAILED = :"sales_order.accounting_sync_failed"
|
|
158
|
+
|
|
159
|
+
# @!method self.values
|
|
160
|
+
# @return [Array<Symbol>]
|
|
161
|
+
end
|
|
162
|
+
end
|
|
163
|
+
end
|
|
164
|
+
end
|
|
@@ -0,0 +1,158 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Orb
|
|
4
|
+
module Models
|
|
5
|
+
class SalesOrderAccountingSyncSucceededWebhookEvent < 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 accounting_sync_record
|
|
13
|
+
#
|
|
14
|
+
# @return [Orb::Models::SalesOrderAccountingSyncSucceededWebhookEvent::AccountingSyncRecord]
|
|
15
|
+
required :accounting_sync_record,
|
|
16
|
+
-> { Orb::SalesOrderAccountingSyncSucceededWebhookEvent::AccountingSyncRecord }
|
|
17
|
+
|
|
18
|
+
# @!attribute created_at
|
|
19
|
+
# The time at which this event was created, to the second.
|
|
20
|
+
#
|
|
21
|
+
# @return [Time]
|
|
22
|
+
required :created_at, Time
|
|
23
|
+
|
|
24
|
+
# @!attribute invoice
|
|
25
|
+
# An [`Invoice`](/core-concepts#invoice) is a fundamental billing entity,
|
|
26
|
+
# representing the request for payment for a single subscription. This includes a
|
|
27
|
+
# set of line items, which correspond to prices in the subscription's plan and can
|
|
28
|
+
# represent fixed recurring fees or usage-based fees. They are generated at the
|
|
29
|
+
# end of a billing period, or as the result of an action, such as a cancellation.
|
|
30
|
+
#
|
|
31
|
+
# @return [Orb::Models::Invoice]
|
|
32
|
+
required :invoice, -> { Orb::Invoice }
|
|
33
|
+
|
|
34
|
+
# @!attribute properties
|
|
35
|
+
#
|
|
36
|
+
# @return [Orb::Models::SalesOrderAccountingSyncSucceededWebhookEvent::Properties]
|
|
37
|
+
required :properties, -> { Orb::SalesOrderAccountingSyncSucceededWebhookEvent::Properties }
|
|
38
|
+
|
|
39
|
+
# @!attribute type
|
|
40
|
+
# The event this payload describes.
|
|
41
|
+
#
|
|
42
|
+
# @return [Symbol, Orb::Models::SalesOrderAccountingSyncSucceededWebhookEvent::Type]
|
|
43
|
+
required :type, enum: -> { Orb::SalesOrderAccountingSyncSucceededWebhookEvent::Type }
|
|
44
|
+
|
|
45
|
+
# @!method initialize(id:, accounting_sync_record:, created_at:, invoice:, properties:, type:)
|
|
46
|
+
# Some parameter documentations has been truncated, see
|
|
47
|
+
# {Orb::Models::SalesOrderAccountingSyncSucceededWebhookEvent} for more details.
|
|
48
|
+
#
|
|
49
|
+
# Issued when a sales order accounting sync succeeds.
|
|
50
|
+
#
|
|
51
|
+
# @param id [String] The ID of this webhook event.
|
|
52
|
+
#
|
|
53
|
+
# @param accounting_sync_record [Orb::Models::SalesOrderAccountingSyncSucceededWebhookEvent::AccountingSyncRecord]
|
|
54
|
+
#
|
|
55
|
+
# @param created_at [Time] The time at which this event was created, to the second.
|
|
56
|
+
#
|
|
57
|
+
# @param invoice [Orb::Models::Invoice] An [`Invoice`](/core-concepts#invoice) is a fundamental billing entity, represen
|
|
58
|
+
#
|
|
59
|
+
# @param properties [Orb::Models::SalesOrderAccountingSyncSucceededWebhookEvent::Properties]
|
|
60
|
+
#
|
|
61
|
+
# @param type [Symbol, Orb::Models::SalesOrderAccountingSyncSucceededWebhookEvent::Type] The event this payload describes.
|
|
62
|
+
|
|
63
|
+
# @see Orb::Models::SalesOrderAccountingSyncSucceededWebhookEvent#accounting_sync_record
|
|
64
|
+
class AccountingSyncRecord < Orb::Internal::Type::BaseModel
|
|
65
|
+
# @!attribute id
|
|
66
|
+
#
|
|
67
|
+
# @return [String]
|
|
68
|
+
required :id, String
|
|
69
|
+
|
|
70
|
+
# @!attribute customer_id
|
|
71
|
+
#
|
|
72
|
+
# @return [String]
|
|
73
|
+
required :customer_id, String
|
|
74
|
+
|
|
75
|
+
# @!attribute record_type
|
|
76
|
+
#
|
|
77
|
+
# @return [Symbol, Orb::Models::SalesOrderAccountingSyncSucceededWebhookEvent::AccountingSyncRecord::RecordType]
|
|
78
|
+
required :record_type,
|
|
79
|
+
enum: -> { Orb::SalesOrderAccountingSyncSucceededWebhookEvent::AccountingSyncRecord::RecordType }
|
|
80
|
+
|
|
81
|
+
# @!attribute error_details
|
|
82
|
+
#
|
|
83
|
+
# @return [Hash{Symbol=>Object}, nil]
|
|
84
|
+
optional :error_details, Orb::Internal::Type::HashOf[Orb::Internal::Type::Unknown], nil?: true
|
|
85
|
+
|
|
86
|
+
# @!attribute invoice_id
|
|
87
|
+
#
|
|
88
|
+
# @return [String, nil]
|
|
89
|
+
optional :invoice_id, String, nil?: true
|
|
90
|
+
|
|
91
|
+
# @!attribute provider_customer_id
|
|
92
|
+
#
|
|
93
|
+
# @return [String, nil]
|
|
94
|
+
optional :provider_customer_id, String, nil?: true
|
|
95
|
+
|
|
96
|
+
# @!attribute status
|
|
97
|
+
#
|
|
98
|
+
# @return [String, nil]
|
|
99
|
+
optional :status, String, nil?: true
|
|
100
|
+
|
|
101
|
+
# @!attribute sync_action
|
|
102
|
+
#
|
|
103
|
+
# @return [String, nil]
|
|
104
|
+
optional :sync_action, String, nil?: true
|
|
105
|
+
|
|
106
|
+
# @!method initialize(id:, customer_id:, record_type:, error_details: nil, invoice_id: nil, provider_customer_id: nil, status: nil, sync_action: nil)
|
|
107
|
+
# @param id [String]
|
|
108
|
+
# @param customer_id [String]
|
|
109
|
+
# @param record_type [Symbol, Orb::Models::SalesOrderAccountingSyncSucceededWebhookEvent::AccountingSyncRecord::RecordType]
|
|
110
|
+
# @param error_details [Hash{Symbol=>Object}, nil]
|
|
111
|
+
# @param invoice_id [String, nil]
|
|
112
|
+
# @param provider_customer_id [String, nil]
|
|
113
|
+
# @param status [String, nil]
|
|
114
|
+
# @param sync_action [String, nil]
|
|
115
|
+
|
|
116
|
+
# @see Orb::Models::SalesOrderAccountingSyncSucceededWebhookEvent::AccountingSyncRecord#record_type
|
|
117
|
+
module RecordType
|
|
118
|
+
extend Orb::Internal::Type::Enum
|
|
119
|
+
|
|
120
|
+
CUSTOMER = :customer
|
|
121
|
+
INVOICE = :invoice
|
|
122
|
+
TRANSACTION = :transaction
|
|
123
|
+
CUSTOMER_BALANCE_TRANSACTION = :customer_balance_transaction
|
|
124
|
+
CREDIT_NOTE = :credit_note
|
|
125
|
+
SUBSCRIPTION = :subscription
|
|
126
|
+
SALES_ORDER = :sales_order
|
|
127
|
+
BLOCK = :block
|
|
128
|
+
|
|
129
|
+
# @!method self.values
|
|
130
|
+
# @return [Array<Symbol>]
|
|
131
|
+
end
|
|
132
|
+
end
|
|
133
|
+
|
|
134
|
+
# @see Orb::Models::SalesOrderAccountingSyncSucceededWebhookEvent#properties
|
|
135
|
+
class Properties < Orb::Internal::Type::BaseModel
|
|
136
|
+
# @!attribute connection_type
|
|
137
|
+
#
|
|
138
|
+
# @return [String]
|
|
139
|
+
required :connection_type, String
|
|
140
|
+
|
|
141
|
+
# @!method initialize(connection_type:)
|
|
142
|
+
# @param connection_type [String]
|
|
143
|
+
end
|
|
144
|
+
|
|
145
|
+
# The event this payload describes.
|
|
146
|
+
#
|
|
147
|
+
# @see Orb::Models::SalesOrderAccountingSyncSucceededWebhookEvent#type
|
|
148
|
+
module Type
|
|
149
|
+
extend Orb::Internal::Type::Enum
|
|
150
|
+
|
|
151
|
+
SALES_ORDER_ACCOUNTING_SYNC_SUCCEEDED = :"sales_order.accounting_sync_succeeded"
|
|
152
|
+
|
|
153
|
+
# @!method self.values
|
|
154
|
+
# @return [Array<Symbol>]
|
|
155
|
+
end
|
|
156
|
+
end
|
|
157
|
+
end
|
|
158
|
+
end
|
|
@@ -0,0 +1,178 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Orb
|
|
4
|
+
module Models
|
|
5
|
+
class SubscriptionAccountingSyncFailedWebhookEvent < 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 accounting_sync_record
|
|
13
|
+
#
|
|
14
|
+
# @return [Orb::Models::SubscriptionAccountingSyncFailedWebhookEvent::AccountingSyncRecord]
|
|
15
|
+
required :accounting_sync_record,
|
|
16
|
+
-> { Orb::SubscriptionAccountingSyncFailedWebhookEvent::AccountingSyncRecord }
|
|
17
|
+
|
|
18
|
+
# @!attribute created_at
|
|
19
|
+
# The time at which this event was created, to the second.
|
|
20
|
+
#
|
|
21
|
+
# @return [Time]
|
|
22
|
+
required :created_at, Time
|
|
23
|
+
|
|
24
|
+
# @!attribute properties
|
|
25
|
+
#
|
|
26
|
+
# @return [Orb::Models::SubscriptionAccountingSyncFailedWebhookEvent::Properties]
|
|
27
|
+
required :properties, -> { Orb::SubscriptionAccountingSyncFailedWebhookEvent::Properties }
|
|
28
|
+
|
|
29
|
+
# @!attribute subscription
|
|
30
|
+
# A [subscription](/core-concepts#subscription) represents the purchase of a plan
|
|
31
|
+
# by a customer.
|
|
32
|
+
#
|
|
33
|
+
# By default, subscriptions begin on the day that they're created and renew
|
|
34
|
+
# automatically for each billing cycle at the cadence that's configured in the
|
|
35
|
+
# plan definition.
|
|
36
|
+
#
|
|
37
|
+
# Subscriptions also default to **beginning of month alignment**, which means the
|
|
38
|
+
# first invoice issued for the subscription will have pro-rated charges between
|
|
39
|
+
# the `start_date` and the first of the following month. Subsequent billing
|
|
40
|
+
# periods will always start and end on a month boundary (e.g. subsequent month
|
|
41
|
+
# starts for monthly billing).
|
|
42
|
+
#
|
|
43
|
+
# Depending on the plan configuration, any _flat_ recurring fees will be billed
|
|
44
|
+
# either at the beginning (in-advance) or end (in-arrears) of each billing cycle.
|
|
45
|
+
# Plans default to **in-advance billing**. Usage-based fees are billed in arrears
|
|
46
|
+
# as usage is accumulated. In the normal course of events, you can expect an
|
|
47
|
+
# invoice to contain usage-based charges for the previous period, and a recurring
|
|
48
|
+
# fee for the following period.
|
|
49
|
+
#
|
|
50
|
+
# @return [Orb::Models::Subscription]
|
|
51
|
+
required :subscription, -> { Orb::Subscription }
|
|
52
|
+
|
|
53
|
+
# @!attribute type
|
|
54
|
+
# The event this payload describes.
|
|
55
|
+
#
|
|
56
|
+
# @return [Symbol, Orb::Models::SubscriptionAccountingSyncFailedWebhookEvent::Type]
|
|
57
|
+
required :type, enum: -> { Orb::SubscriptionAccountingSyncFailedWebhookEvent::Type }
|
|
58
|
+
|
|
59
|
+
# @!method initialize(id:, accounting_sync_record:, created_at:, properties:, subscription:, type:)
|
|
60
|
+
# Some parameter documentations has been truncated, see
|
|
61
|
+
# {Orb::Models::SubscriptionAccountingSyncFailedWebhookEvent} for more details.
|
|
62
|
+
#
|
|
63
|
+
# Issued when a subscription accounting sync fails.
|
|
64
|
+
#
|
|
65
|
+
# @param id [String] The ID of this webhook event.
|
|
66
|
+
#
|
|
67
|
+
# @param accounting_sync_record [Orb::Models::SubscriptionAccountingSyncFailedWebhookEvent::AccountingSyncRecord]
|
|
68
|
+
#
|
|
69
|
+
# @param created_at [Time] The time at which this event was created, to the second.
|
|
70
|
+
#
|
|
71
|
+
# @param properties [Orb::Models::SubscriptionAccountingSyncFailedWebhookEvent::Properties]
|
|
72
|
+
#
|
|
73
|
+
# @param subscription [Orb::Models::Subscription] A [subscription](/core-concepts#subscription) represents the purchase of a plan
|
|
74
|
+
#
|
|
75
|
+
# @param type [Symbol, Orb::Models::SubscriptionAccountingSyncFailedWebhookEvent::Type] The event this payload describes.
|
|
76
|
+
|
|
77
|
+
# @see Orb::Models::SubscriptionAccountingSyncFailedWebhookEvent#accounting_sync_record
|
|
78
|
+
class AccountingSyncRecord < Orb::Internal::Type::BaseModel
|
|
79
|
+
# @!attribute id
|
|
80
|
+
#
|
|
81
|
+
# @return [String]
|
|
82
|
+
required :id, String
|
|
83
|
+
|
|
84
|
+
# @!attribute customer_id
|
|
85
|
+
#
|
|
86
|
+
# @return [String]
|
|
87
|
+
required :customer_id, String
|
|
88
|
+
|
|
89
|
+
# @!attribute record_type
|
|
90
|
+
#
|
|
91
|
+
# @return [Symbol, Orb::Models::SubscriptionAccountingSyncFailedWebhookEvent::AccountingSyncRecord::RecordType]
|
|
92
|
+
required :record_type,
|
|
93
|
+
enum: -> { Orb::SubscriptionAccountingSyncFailedWebhookEvent::AccountingSyncRecord::RecordType }
|
|
94
|
+
|
|
95
|
+
# @!attribute error_details
|
|
96
|
+
#
|
|
97
|
+
# @return [Hash{Symbol=>Object}, nil]
|
|
98
|
+
optional :error_details, Orb::Internal::Type::HashOf[Orb::Internal::Type::Unknown], nil?: true
|
|
99
|
+
|
|
100
|
+
# @!attribute provider_customer_id
|
|
101
|
+
#
|
|
102
|
+
# @return [String, nil]
|
|
103
|
+
optional :provider_customer_id, String, nil?: true
|
|
104
|
+
|
|
105
|
+
# @!attribute status
|
|
106
|
+
#
|
|
107
|
+
# @return [String, nil]
|
|
108
|
+
optional :status, String, nil?: true
|
|
109
|
+
|
|
110
|
+
# @!attribute subscription_id
|
|
111
|
+
#
|
|
112
|
+
# @return [String, nil]
|
|
113
|
+
optional :subscription_id, String, nil?: true
|
|
114
|
+
|
|
115
|
+
# @!attribute sync_action
|
|
116
|
+
#
|
|
117
|
+
# @return [String, nil]
|
|
118
|
+
optional :sync_action, String, nil?: true
|
|
119
|
+
|
|
120
|
+
# @!method initialize(id:, customer_id:, record_type:, error_details: nil, provider_customer_id: nil, status: nil, subscription_id: nil, sync_action: nil)
|
|
121
|
+
# @param id [String]
|
|
122
|
+
# @param customer_id [String]
|
|
123
|
+
# @param record_type [Symbol, Orb::Models::SubscriptionAccountingSyncFailedWebhookEvent::AccountingSyncRecord::RecordType]
|
|
124
|
+
# @param error_details [Hash{Symbol=>Object}, nil]
|
|
125
|
+
# @param provider_customer_id [String, nil]
|
|
126
|
+
# @param status [String, nil]
|
|
127
|
+
# @param subscription_id [String, nil]
|
|
128
|
+
# @param sync_action [String, nil]
|
|
129
|
+
|
|
130
|
+
# @see Orb::Models::SubscriptionAccountingSyncFailedWebhookEvent::AccountingSyncRecord#record_type
|
|
131
|
+
module RecordType
|
|
132
|
+
extend Orb::Internal::Type::Enum
|
|
133
|
+
|
|
134
|
+
CUSTOMER = :customer
|
|
135
|
+
INVOICE = :invoice
|
|
136
|
+
TRANSACTION = :transaction
|
|
137
|
+
CUSTOMER_BALANCE_TRANSACTION = :customer_balance_transaction
|
|
138
|
+
CREDIT_NOTE = :credit_note
|
|
139
|
+
SUBSCRIPTION = :subscription
|
|
140
|
+
SALES_ORDER = :sales_order
|
|
141
|
+
BLOCK = :block
|
|
142
|
+
|
|
143
|
+
# @!method self.values
|
|
144
|
+
# @return [Array<Symbol>]
|
|
145
|
+
end
|
|
146
|
+
end
|
|
147
|
+
|
|
148
|
+
# @see Orb::Models::SubscriptionAccountingSyncFailedWebhookEvent#properties
|
|
149
|
+
class Properties < Orb::Internal::Type::BaseModel
|
|
150
|
+
# @!attribute connection_type
|
|
151
|
+
#
|
|
152
|
+
# @return [String]
|
|
153
|
+
required :connection_type, String
|
|
154
|
+
|
|
155
|
+
# @!attribute failure_reason
|
|
156
|
+
#
|
|
157
|
+
# @return [String]
|
|
158
|
+
required :failure_reason, String
|
|
159
|
+
|
|
160
|
+
# @!method initialize(connection_type:, failure_reason:)
|
|
161
|
+
# @param connection_type [String]
|
|
162
|
+
# @param failure_reason [String]
|
|
163
|
+
end
|
|
164
|
+
|
|
165
|
+
# The event this payload describes.
|
|
166
|
+
#
|
|
167
|
+
# @see Orb::Models::SubscriptionAccountingSyncFailedWebhookEvent#type
|
|
168
|
+
module Type
|
|
169
|
+
extend Orb::Internal::Type::Enum
|
|
170
|
+
|
|
171
|
+
SUBSCRIPTION_ACCOUNTING_SYNC_FAILED = :"subscription.accounting_sync_failed"
|
|
172
|
+
|
|
173
|
+
# @!method self.values
|
|
174
|
+
# @return [Array<Symbol>]
|
|
175
|
+
end
|
|
176
|
+
end
|
|
177
|
+
end
|
|
178
|
+
end
|