orb-billing 0.3.0 → 0.3.2
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 +47 -0
- data/README.md +7 -7
- data/lib/orb/errors.rb +9 -9
- data/lib/orb/file_part.rb +2 -2
- data/lib/orb/internal/page.rb +3 -3
- data/lib/orb/internal/transport/base_client.rb +3 -3
- data/lib/orb/internal/type/base_model.rb +1 -9
- data/lib/orb/internal/type/boolean.rb +10 -11
- data/lib/orb/internal/type/enum.rb +13 -14
- data/lib/orb/internal/type/request_parameters.rb +6 -12
- data/lib/orb/internal/type/union.rb +4 -4
- data/lib/orb/internal/type/unknown.rb +10 -11
- data/lib/orb/internal/util.rb +21 -5
- data/lib/orb/models/alert.rb +29 -32
- data/lib/orb/models/alert_create_for_customer_params.rb +7 -8
- data/lib/orb/models/alert_create_for_external_customer_params.rb +7 -8
- data/lib/orb/models/alert_create_for_subscription_params.rb +7 -8
- data/lib/orb/models/alert_list_params.rb +0 -1
- data/lib/orb/models/alert_update_params.rb +4 -5
- data/lib/orb/models/amount_discount.rb +6 -7
- data/lib/orb/models/billable_metric.rb +9 -11
- data/lib/orb/models/coupon.rb +9 -12
- data/lib/orb/models/coupon_create_params.rb +8 -10
- data/lib/orb/models/coupon_list_params.rb +0 -2
- data/lib/orb/models/coupons/subscription_list_params.rb +0 -1
- data/lib/orb/models/credit_note.rb +48 -46
- data/lib/orb/models/credit_note_create_params.rb +6 -6
- data/lib/orb/models/credit_note_list_params.rb +0 -1
- data/lib/orb/models/customer.rb +54 -61
- data/lib/orb/models/customer_create_params.rb +43 -55
- data/lib/orb/models/customer_list_params.rb +0 -1
- data/lib/orb/models/customer_update_by_external_id_params.rb +43 -57
- data/lib/orb/models/customer_update_params.rb +43 -53
- data/lib/orb/models/customers/balance_transaction_create_params.rb +3 -3
- data/lib/orb/models/customers/balance_transaction_create_response.rb +0 -2
- data/lib/orb/models/customers/balance_transaction_list_params.rb +0 -1
- data/lib/orb/models/customers/balance_transaction_list_response.rb +0 -2
- data/lib/orb/models/customers/cost_list_by_external_id_params.rb +3 -4
- data/lib/orb/models/customers/cost_list_by_external_id_response.rb +3 -3
- data/lib/orb/models/customers/cost_list_params.rb +3 -4
- data/lib/orb/models/customers/cost_list_response.rb +3 -3
- data/lib/orb/models/customers/credit_list_by_external_id_params.rb +0 -2
- data/lib/orb/models/customers/credit_list_params.rb +0 -2
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +12 -21
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +106 -114
- data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +11 -22
- data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +111 -126
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +6 -7
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +110 -121
- data/lib/orb/models/customers/credits/ledger_list_params.rb +8 -9
- data/lib/orb/models/customers/credits/ledger_list_response.rb +112 -131
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +10 -15
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +0 -6
- data/lib/orb/models/customers/credits/top_up_create_params.rb +7 -15
- data/lib/orb/models/customers/credits/top_up_create_response.rb +0 -6
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +0 -1
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +0 -6
- data/lib/orb/models/customers/credits/top_up_list_params.rb +0 -1
- data/lib/orb/models/customers/credits/top_up_list_response.rb +0 -6
- data/lib/orb/models/dimensional_price_group.rb +1 -3
- data/lib/orb/models/dimensional_price_group_create_params.rb +0 -1
- data/lib/orb/models/dimensional_price_group_list_params.rb +0 -1
- data/lib/orb/models/dimensional_price_groups.rb +6 -6
- data/lib/orb/models/discount.rb +5 -5
- data/lib/orb/models/evaluate_price_group.rb +1 -1
- data/lib/orb/models/event_ingest_params.rb +4 -9
- data/lib/orb/models/event_ingest_response.rb +0 -3
- data/lib/orb/models/event_search_params.rb +0 -3
- data/lib/orb/models/event_search_response.rb +0 -4
- data/lib/orb/models/event_update_params.rb +0 -3
- data/lib/orb/models/events/backfill_close_response.rb +0 -4
- data/lib/orb/models/events/backfill_create_params.rb +0 -7
- data/lib/orb/models/events/backfill_create_response.rb +0 -4
- data/lib/orb/models/events/backfill_fetch_response.rb +0 -4
- data/lib/orb/models/events/backfill_list_params.rb +0 -1
- data/lib/orb/models/events/backfill_list_response.rb +0 -4
- data/lib/orb/models/events/backfill_revert_response.rb +0 -4
- data/lib/orb/models/events/event_volumes.rb +3 -3
- data/lib/orb/models/events/volume_list_params.rb +0 -3
- data/lib/orb/models/invoice.rb +165 -224
- data/lib/orb/models/invoice_create_params.rb +14 -21
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +58 -107
- data/lib/orb/models/invoice_issue_params.rb +0 -1
- data/lib/orb/models/invoice_level_discount.rb +4 -4
- data/lib/orb/models/invoice_line_item_create_params.rb +0 -1
- data/lib/orb/models/invoice_line_item_create_response.rb +58 -81
- data/lib/orb/models/invoice_list_params.rb +6 -10
- data/lib/orb/models/invoice_update_params.rb +0 -1
- data/lib/orb/models/item.rb +7 -8
- data/lib/orb/models/item_list_params.rb +0 -1
- data/lib/orb/models/item_update_params.rb +7 -7
- data/lib/orb/models/metric_create_params.rb +0 -1
- data/lib/orb/models/metric_list_params.rb +0 -1
- data/lib/orb/models/metric_update_params.rb +0 -1
- data/lib/orb/models/percentage_discount.rb +6 -8
- data/lib/orb/models/plan.rb +83 -111
- data/lib/orb/models/plan_create_params.rb +753 -861
- data/lib/orb/models/plan_list_params.rb +3 -4
- data/lib/orb/models/plan_update_params.rb +0 -2
- data/lib/orb/models/plans/external_plan_id_update_params.rb +0 -2
- data/lib/orb/models/price.rb +1699 -1804
- data/lib/orb/models/price_create_params.rb +75 -84
- data/lib/orb/models/price_evaluate_params.rb +0 -2
- data/lib/orb/models/price_evaluate_response.rb +3 -3
- data/lib/orb/models/price_list_params.rb +0 -1
- data/lib/orb/models/price_update_params.rb +0 -1
- data/lib/orb/models/prices/external_price_id_update_params.rb +0 -1
- data/lib/orb/models/subscription.rb +94 -136
- data/lib/orb/models/subscription_cancel_params.rb +3 -5
- data/lib/orb/models/subscription_cancel_response.rb +52 -91
- data/lib/orb/models/subscription_change_apply_response.rb +50 -88
- data/lib/orb/models/subscription_change_cancel_response.rb +50 -87
- data/lib/orb/models/subscription_change_retrieve_response.rb +50 -87
- data/lib/orb/models/subscription_create_params.rb +1927 -1928
- data/lib/orb/models/subscription_create_response.rb +52 -91
- data/lib/orb/models/subscription_fetch_costs_params.rb +3 -4
- data/lib/orb/models/subscription_fetch_costs_response.rb +3 -3
- data/lib/orb/models/subscription_fetch_schedule_params.rb +0 -1
- data/lib/orb/models/subscription_fetch_schedule_response.rb +0 -1
- data/lib/orb/models/subscription_fetch_usage_params.rb +6 -8
- data/lib/orb/models/subscription_list_params.rb +3 -4
- data/lib/orb/models/subscription_price_intervals_params.rb +1141 -1079
- data/lib/orb/models/subscription_price_intervals_response.rb +51 -90
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +1966 -1906
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +50 -88
- data/lib/orb/models/subscription_trigger_phase_params.rb +0 -2
- data/lib/orb/models/subscription_trigger_phase_response.rb +51 -90
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +50 -88
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +50 -86
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +50 -86
- data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +3 -6
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +50 -88
- data/lib/orb/models/subscription_update_params.rb +0 -5
- data/lib/orb/models/subscription_update_trial_params.rb +4 -6
- data/lib/orb/models/subscription_update_trial_response.rb +52 -91
- data/lib/orb/models/subscription_usage.rb +46 -39
- data/lib/orb/models/subscriptions.rb +6 -6
- data/lib/orb/models/trial_discount.rb +6 -7
- data/lib/orb/models/usage_discount.rb +6 -8
- data/lib/orb/models.rb +220 -0
- data/lib/orb/request_options.rb +4 -5
- data/lib/orb/resources/alerts.rb +30 -31
- data/lib/orb/resources/coupons/subscriptions.rb +3 -4
- data/lib/orb/resources/coupons.rb +11 -21
- data/lib/orb/resources/credit_notes.rb +10 -11
- data/lib/orb/resources/customers/balance_transactions.rb +3 -4
- data/lib/orb/resources/customers/costs.rb +4 -6
- data/lib/orb/resources/customers/credits/ledger.rb +18 -37
- data/lib/orb/resources/customers/credits/top_ups.rb +10 -20
- data/lib/orb/resources/customers/credits.rb +2 -6
- data/lib/orb/resources/customers.rb +40 -67
- data/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rb +2 -2
- data/lib/orb/resources/dimensional_price_groups.rb +8 -10
- data/lib/orb/resources/events/backfills.rb +2 -10
- data/lib/orb/resources/events/volume.rb +3 -6
- data/lib/orb/resources/events.rb +4 -12
- data/lib/orb/resources/invoice_line_items.rb +1 -2
- data/lib/orb/resources/invoices.rb +26 -43
- data/lib/orb/resources/items.rb +12 -13
- data/lib/orb/resources/metrics.rb +11 -14
- data/lib/orb/resources/plans/external_plan_id.rb +5 -7
- data/lib/orb/resources/plans.rb +14 -23
- data/lib/orb/resources/prices/external_price_id.rb +5 -6
- data/lib/orb/resources/prices.rb +25 -35
- data/lib/orb/resources/subscription_changes.rb +1 -1
- data/lib/orb/resources/subscriptions.rb +49 -107
- data/lib/orb/version.rb +1 -1
- data/lib/orb.rb +1 -0
- data/rbi/{lib/orb → orb}/client.rbi +5 -4
- data/rbi/{lib/orb → orb}/errors.rbi +58 -27
- data/rbi/{lib/orb → orb}/file_part.rbi +9 -6
- data/rbi/{lib/orb → orb}/internal/page.rbi +19 -6
- data/rbi/{lib/orb → orb}/internal/transport/base_client.rbi +131 -73
- data/rbi/{lib/orb → orb}/internal/transport/pooled_net_requester.rbi +25 -12
- data/rbi/orb/internal/type/array_of.rbi +98 -0
- data/rbi/{lib/orb → orb}/internal/type/base_model.rbi +124 -65
- data/rbi/{lib/orb → orb}/internal/type/base_page.rbi +11 -7
- data/rbi/{lib/orb → orb}/internal/type/boolean.rbi +16 -10
- data/rbi/{lib/orb → orb}/internal/type/converter.rbi +66 -31
- data/rbi/{lib/orb → orb}/internal/type/enum.rbi +27 -15
- data/rbi/{lib/orb → orb}/internal/type/file_input.rbi +12 -10
- data/rbi/{lib/orb → orb}/internal/type/hash_of.rbi +34 -24
- data/rbi/orb/internal/type/request_parameters.rbi +29 -0
- data/rbi/orb/internal/type/union.rbi +110 -0
- data/rbi/orb/internal/type/unknown.rbi +50 -0
- data/rbi/orb/internal/util.rbi +424 -0
- data/rbi/{lib/orb → orb}/models/alert.rbi +107 -70
- data/rbi/{lib/orb → orb}/models/alert_create_for_customer_params.rbi +60 -27
- data/rbi/{lib/orb → orb}/models/alert_create_for_external_customer_params.rbi +68 -29
- data/rbi/{lib/orb → orb}/models/alert_create_for_subscription_params.rbi +53 -26
- data/rbi/{lib/orb → orb}/models/alert_disable_params.rbi +17 -6
- data/rbi/{lib/orb → orb}/models/alert_enable_params.rbi +17 -6
- data/rbi/{lib/orb → orb}/models/alert_list_params.rbi +23 -20
- data/rbi/orb/models/alert_retrieve_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/alert_update_params.rbi +25 -14
- data/rbi/{lib/orb → orb}/models/amount_discount.rbi +28 -19
- data/rbi/{lib/orb → orb}/models/billable_metric.rbi +33 -26
- data/rbi/orb/models/billing_cycle_relative_date.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/coupon.rbi +28 -20
- data/rbi/orb/models/coupon_archive_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/coupon_create_params.rbi +74 -40
- data/rbi/orb/models/coupon_fetch_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/coupon_list_params.rbi +18 -15
- data/rbi/{lib/orb → orb}/models/coupons/subscription_list_params.rbi +16 -6
- data/rbi/{lib/orb → orb}/models/credit_note.rbi +293 -158
- data/rbi/orb/models/credit_note_create_params.rbi +117 -0
- data/rbi/orb/models/credit_note_fetch_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/credit_note_list_params.rbi +20 -17
- data/rbi/{lib/orb → orb}/models/customer.rbi +430 -329
- data/rbi/{lib/orb → orb}/models/customer_create_params.rbi +664 -327
- data/rbi/orb/models/customer_delete_params.rbi +24 -0
- data/rbi/orb/models/customer_fetch_by_external_id_params.rbi +24 -0
- data/rbi/orb/models/customer_fetch_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/customer_list_params.rbi +20 -17
- data/rbi/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +24 -0
- data/rbi/orb/models/customer_sync_payment_methods_from_gateway_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/customer_update_by_external_id_params.rbi +1138 -338
- data/rbi/{lib/orb → orb}/models/customer_update_params.rbi +663 -326
- data/rbi/orb/models/customers/balance_transaction_create_params.rbi +94 -0
- data/rbi/orb/models/customers/balance_transaction_create_response.rbi +301 -0
- data/rbi/{lib/orb → orb}/models/customers/balance_transaction_list_params.rbi +20 -17
- data/rbi/orb/models/customers/balance_transaction_list_response.rbi +301 -0
- data/rbi/{lib/orb → orb}/models/customers/cost_list_by_external_id_params.rbi +56 -22
- data/rbi/orb/models/customers/cost_list_by_external_id_response.rbi +263 -0
- data/rbi/{lib/orb → orb}/models/customers/cost_list_params.rbi +45 -22
- data/rbi/orb/models/customers/cost_list_response.rbi +254 -0
- data/rbi/{lib/orb → orb}/models/customers/credit_list_by_external_id_params.rbi +18 -15
- data/rbi/orb/models/customers/credit_list_by_external_id_response.rbi +110 -0
- data/rbi/{lib/orb → orb}/models/customers/credit_list_params.rbi +18 -15
- data/rbi/{lib/orb → orb}/models/customers/credit_list_response.rbi +44 -21
- data/rbi/{lib/orb/models/customers/credits/ledger_create_entry_params.rbi → orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi} +118 -60
- data/rbi/{lib/orb/models/customers/credits/ledger_create_entry_response.rbi → orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi} +685 -468
- data/rbi/{lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi → orb/models/customers/credits/ledger_create_entry_params.rbi} +107 -69
- data/rbi/{lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi → orb/models/customers/credits/ledger_create_entry_response.rbi} +643 -470
- data/rbi/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +224 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_list_by_external_id_response.rbi +658 -469
- data/rbi/orb/models/customers/credits/ledger_list_params.rbi +224 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_list_response.rbi +708 -459
- data/rbi/{lib/orb/models/customers/credits/top_up_create_params.rbi → orb/models/customers/credits/top_up_create_by_external_id_params.rbi} +87 -46
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_by_external_id_response.rbi +65 -48
- data/rbi/{lib/orb/models/customers/credits/top_up_create_by_external_id_params.rbi → orb/models/customers/credits/top_up_create_params.rbi} +73 -54
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_response.rbi +83 -43
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_delete_by_external_id_params.rbi +16 -6
- data/rbi/orb/models/customers/credits/top_up_delete_params.rbi +36 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_by_external_id_params.rbi +9 -5
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_by_external_id_response.rbi +70 -49
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_params.rbi +9 -5
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_response.rbi +84 -43
- data/rbi/{lib/orb → orb}/models/dimensional_price_group.rbi +18 -15
- data/rbi/{lib/orb → orb}/models/dimensional_price_group_create_params.rbi +19 -16
- data/rbi/{lib/orb → orb}/models/dimensional_price_group_list_params.rbi +16 -6
- data/rbi/orb/models/dimensional_price_group_retrieve_params.rbi +24 -0
- data/rbi/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +26 -0
- data/rbi/orb/models/dimensional_price_groups.rbi +38 -0
- data/rbi/orb/models/discount.rbi +23 -0
- data/rbi/{lib/orb → orb}/models/evaluate_price_group.rbi +28 -12
- data/rbi/orb/models/event_deprecate_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/event_deprecate_response.rbi +8 -3
- data/rbi/{lib/orb → orb}/models/event_ingest_params.rbi +37 -31
- data/rbi/{lib/orb → orb}/models/event_ingest_response.rbi +63 -23
- data/rbi/{lib/orb → orb}/models/event_search_params.rbi +17 -14
- data/rbi/{lib/orb → orb}/models/event_search_response.rbi +33 -21
- data/rbi/{lib/orb → orb}/models/event_update_params.rbi +19 -16
- data/rbi/{lib/orb → orb}/models/event_update_response.rbi +8 -3
- data/rbi/orb/models/events/backfill_close_params.rbi +26 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_close_response.rbi +64 -29
- data/rbi/{lib/orb → orb}/models/events/backfill_create_params.rbi +21 -18
- data/rbi/{lib/orb → orb}/models/events/backfill_create_response.rbi +63 -29
- data/rbi/orb/models/events/backfill_fetch_params.rbi +26 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_fetch_response.rbi +64 -29
- data/rbi/{lib/orb → orb}/models/events/backfill_list_params.rbi +16 -6
- data/rbi/{lib/orb → orb}/models/events/backfill_list_response.rbi +62 -28
- data/rbi/orb/models/events/backfill_revert_params.rbi +26 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_revert_response.rbi +63 -29
- data/rbi/{lib/orb → orb}/models/events/event_volumes.rbi +34 -12
- data/rbi/{lib/orb → orb}/models/events/volume_list_params.rbi +18 -15
- data/rbi/{lib/orb → orb}/models/invoice.rbi +1294 -831
- data/rbi/{lib/orb → orb}/models/invoice_create_params.rbi +97 -69
- data/rbi/orb/models/invoice_fetch_params.rbi +24 -0
- data/rbi/orb/models/invoice_fetch_upcoming_params.rbi +32 -0
- data/rbi/{lib/orb → orb}/models/invoice_fetch_upcoming_response.rbi +2003 -885
- data/rbi/{lib/orb → orb}/models/invoice_issue_params.rbi +16 -5
- data/rbi/orb/models/invoice_level_discount.rbi +22 -0
- data/rbi/{lib/orb → orb}/models/invoice_line_item_create_params.rbi +20 -17
- data/rbi/{lib/orb → orb}/models/invoice_line_item_create_response.rbi +594 -421
- data/rbi/{lib/orb → orb}/models/invoice_list_params.rbi +67 -47
- data/rbi/{lib/orb → orb}/models/invoice_mark_paid_params.rbi +17 -14
- data/rbi/orb/models/invoice_pay_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/invoice_update_params.rbi +15 -10
- data/rbi/orb/models/invoice_void_params.rbi +24 -0
- data/rbi/orb/models/item.rbi +143 -0
- data/rbi/{lib/orb → orb}/models/item_create_params.rbi +14 -5
- data/rbi/orb/models/item_fetch_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/item_list_params.rbi +16 -6
- data/rbi/orb/models/item_update_params.rbi +141 -0
- data/rbi/{lib/orb → orb}/models/metric_create_params.rbi +19 -16
- data/rbi/orb/models/metric_fetch_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/metric_list_params.rbi +20 -17
- data/rbi/{lib/orb → orb}/models/metric_update_params.rbi +15 -10
- data/rbi/orb/models/pagination_metadata.rbi +31 -0
- data/rbi/{lib/orb → orb}/models/percentage_discount.rbi +32 -19
- data/rbi/{lib/orb → orb}/models/plan.rbi +501 -370
- data/rbi/{lib/orb → orb}/models/plan_create_params.rbi +4243 -3094
- data/rbi/orb/models/plan_fetch_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/plan_list_params.rbi +34 -27
- data/rbi/{lib/orb → orb}/models/plan_update_params.rbi +16 -13
- data/rbi/orb/models/plans/external_plan_id_fetch_params.rbi +26 -0
- data/rbi/{lib/orb → orb}/models/plans/external_plan_id_update_params.rbi +16 -13
- data/rbi/orb/models/price.rbi +19414 -0
- data/rbi/{lib/orb → orb}/models/price_create_params.rbi +501 -245
- data/rbi/{lib/orb → orb}/models/price_evaluate_params.rbi +20 -17
- data/rbi/orb/models/price_evaluate_response.rbi +24 -0
- data/rbi/orb/models/price_fetch_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/price_list_params.rbi +16 -6
- data/rbi/{lib/orb → orb}/models/price_update_params.rbi +15 -10
- data/rbi/orb/models/prices/external_price_id_fetch_params.rbi +26 -0
- data/rbi/{lib/orb → orb}/models/prices/external_price_id_update_params.rbi +15 -10
- data/rbi/{lib/orb → orb}/models/subscription.rbi +586 -428
- data/rbi/{lib/orb → orb}/models/subscription_cancel_params.rbi +44 -22
- data/rbi/{lib/orb → orb}/models/subscription_cancel_response.rbi +724 -462
- data/rbi/{lib/orb → orb}/models/subscription_change_apply_params.rbi +16 -13
- data/rbi/{lib/orb → orb}/models/subscription_change_apply_response.rbi +808 -528
- data/rbi/orb/models/subscription_change_cancel_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/subscription_change_cancel_response.rbi +807 -538
- data/rbi/orb/models/subscription_change_retrieve_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/subscription_change_retrieve_response.rbi +806 -548
- data/rbi/{lib/orb/models/subscription_schedule_plan_change_params.rbi → orb/models/subscription_create_params.rbi} +8466 -7080
- data/rbi/{lib/orb → orb}/models/subscription_create_response.rbi +724 -462
- data/rbi/{lib/orb → orb}/models/subscription_fetch_costs_params.rbi +47 -22
- data/rbi/orb/models/subscription_fetch_costs_response.rbi +252 -0
- data/rbi/orb/models/subscription_fetch_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/subscription_fetch_schedule_params.rbi +20 -17
- data/rbi/{lib/orb → orb}/models/subscription_fetch_schedule_response.rbi +33 -19
- data/rbi/{lib/orb → orb}/models/subscription_fetch_usage_params.rbi +81 -34
- data/rbi/{lib/orb → orb}/models/subscription_list_params.rbi +39 -28
- data/rbi/{lib/orb → orb}/models/subscription_price_intervals_params.rbi +4973 -3944
- data/rbi/{lib/orb → orb}/models/subscription_price_intervals_response.rbi +744 -477
- data/rbi/{lib/orb/models/subscription_create_params.rbi → orb/models/subscription_schedule_plan_change_params.rbi} +8649 -7019
- data/rbi/{lib/orb → orb}/models/subscription_schedule_plan_change_response.rbi +742 -491
- data/rbi/{lib/orb → orb}/models/subscription_trigger_phase_params.rbi +16 -13
- data/rbi/{lib/orb → orb}/models/subscription_trigger_phase_response.rbi +736 -472
- data/rbi/orb/models/subscription_unschedule_cancellation_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_cancellation_response.rbi +743 -491
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +16 -5
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +717 -526
- data/rbi/orb/models/subscription_unschedule_pending_plan_changes_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_pending_plan_changes_response.rbi +732 -521
- data/rbi/{lib/orb → orb}/models/subscription_update_fixed_fee_quantity_params.rbi +57 -26
- data/rbi/{lib/orb → orb}/models/subscription_update_fixed_fee_quantity_response.rbi +743 -491
- data/rbi/{lib/orb → orb}/models/subscription_update_params.rbi +19 -16
- data/rbi/orb/models/subscription_update_trial_params.rbi +104 -0
- data/rbi/{lib/orb → orb}/models/subscription_update_trial_response.rbi +736 -471
- data/rbi/orb/models/subscription_usage.rbi +446 -0
- data/rbi/orb/models/subscriptions.rbi +38 -0
- data/rbi/orb/models/top_level_ping_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/top_level_ping_response.rbi +7 -3
- data/rbi/{lib/orb → orb}/models/trial_discount.rbi +29 -20
- data/rbi/{lib/orb → orb}/models/usage_discount.rbi +28 -19
- data/rbi/orb/models.rbi +231 -0
- data/rbi/{lib/orb → orb}/request_options.rbi +12 -4
- data/rbi/{lib/orb → orb}/resources/alerts.rbi +57 -42
- data/rbi/{lib/orb → orb}/resources/coupons/subscriptions.rbi +7 -5
- data/rbi/{lib/orb → orb}/resources/coupons.rbi +25 -22
- data/rbi/{lib/orb → orb}/resources/credit_notes.rbi +18 -15
- data/rbi/{lib/orb → orb}/resources/customers/balance_transactions.rbi +17 -9
- data/rbi/{lib/orb → orb}/resources/customers/costs.rbi +18 -11
- data/rbi/{lib/orb → orb}/resources/customers/credits/ledger.rbi +98 -74
- data/rbi/{lib/orb → orb}/resources/customers/credits/top_ups.rbi +53 -29
- data/rbi/{lib/orb → orb}/resources/customers/credits.rbi +16 -7
- data/rbi/{lib/orb → orb}/resources/customers.rbi +117 -82
- data/rbi/{lib/orb → orb}/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi +6 -5
- data/rbi/{lib/orb → orb}/resources/dimensional_price_groups.rbi +21 -14
- data/rbi/{lib/orb → orb}/resources/events/backfills.rbi +25 -20
- data/rbi/{lib/orb → orb}/resources/events/volume.rbi +7 -5
- data/rbi/{lib/orb → orb}/resources/events.rbi +22 -18
- data/rbi/{lib/orb → orb}/resources/invoice_line_items.rbi +7 -5
- data/rbi/{lib/orb → orb}/resources/invoices.rbi +55 -49
- data/rbi/{lib/orb → orb}/resources/items.rbi +31 -17
- data/rbi/{lib/orb → orb}/resources/metrics.rbi +21 -17
- data/rbi/{lib/orb → orb}/resources/plans/external_plan_id.rbi +11 -9
- data/rbi/{lib/orb → orb}/resources/plans.rbi +53 -49
- data/rbi/orb/resources/prices/external_price_id.rbi +108 -0
- data/rbi/{lib/orb → orb}/resources/prices.rbi +170 -157
- data/rbi/{lib/orb → orb}/resources/subscription_changes.rbi +15 -13
- data/rbi/{lib/orb → orb}/resources/subscriptions.rbi +188 -118
- data/rbi/{lib/orb → orb}/resources/top_level.rbi +7 -4
- data/sig/orb/internal/page.rbs +0 -2
- data/sig/orb/internal/type/request_parameters.rbs +3 -1
- data/sig/orb/internal/util.rbs +2 -0
- data/sig/orb/models/alert.rbs +19 -31
- data/sig/orb/models/alert_create_for_customer_params.rbs +3 -7
- data/sig/orb/models/alert_create_for_external_customer_params.rbs +3 -7
- data/sig/orb/models/alert_create_for_subscription_params.rbs +3 -7
- data/sig/orb/models/alert_disable_params.rbs +0 -2
- data/sig/orb/models/alert_enable_params.rbs +0 -2
- data/sig/orb/models/alert_list_params.rbs +0 -2
- data/sig/orb/models/alert_retrieve_params.rbs +0 -2
- data/sig/orb/models/alert_update_params.rbs +3 -7
- data/sig/orb/models/amount_discount.rbs +4 -6
- data/sig/orb/models/billable_metric.rbs +7 -9
- data/sig/orb/models/coupon.rbs +5 -8
- data/sig/orb/models/coupon_archive_params.rbs +0 -2
- data/sig/orb/models/coupon_create_params.rbs +7 -14
- data/sig/orb/models/coupon_fetch_params.rbs +0 -2
- data/sig/orb/models/coupon_list_params.rbs +0 -2
- data/sig/orb/models/coupons/subscription_list_params.rbs +0 -2
- data/sig/orb/models/credit_note.rbs +48 -66
- data/sig/orb/models/credit_note_create_params.rbs +3 -7
- data/sig/orb/models/credit_note_fetch_params.rbs +0 -2
- data/sig/orb/models/credit_note_list_params.rbs +0 -2
- data/sig/orb/models/customer.rbs +43 -63
- data/sig/orb/models/customer_create_params.rbs +36 -57
- data/sig/orb/models/customer_delete_params.rbs +0 -2
- data/sig/orb/models/customer_fetch_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customer_fetch_params.rbs +0 -2
- data/sig/orb/models/customer_list_params.rbs +0 -2
- data/sig/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbs +0 -2
- data/sig/orb/models/customer_sync_payment_methods_from_gateway_params.rbs +0 -2
- data/sig/orb/models/customer_update_by_external_id_params.rbs +36 -57
- data/sig/orb/models/customer_update_params.rbs +36 -57
- data/sig/orb/models/customers/balance_transaction_create_params.rbs +0 -2
- data/sig/orb/models/customers/balance_transaction_create_response.rbs +0 -6
- data/sig/orb/models/customers/balance_transaction_list_params.rbs +0 -2
- data/sig/orb/models/customers/balance_transaction_list_response.rbs +0 -6
- data/sig/orb/models/customers/cost_list_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/cost_list_by_external_id_response.rbs +0 -6
- data/sig/orb/models/customers/cost_list_params.rbs +0 -2
- data/sig/orb/models/customers/cost_list_response.rbs +0 -6
- data/sig/orb/models/customers/credit_list_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/credit_list_by_external_id_response.rbs +0 -2
- data/sig/orb/models/customers/credit_list_params.rbs +0 -2
- data/sig/orb/models/customers/credit_list_response.rbs +0 -2
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbs +3 -7
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +92 -134
- data/sig/orb/models/customers/credits/ledger_create_entry_params.rbs +3 -7
- data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +92 -134
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +92 -134
- data/sig/orb/models/customers/credits/ledger_list_params.rbs +0 -2
- data/sig/orb/models/customers/credits/ledger_list_response.rbs +92 -134
- data/sig/orb/models/customers/credits/top_up_create_by_external_id_params.rbs +3 -7
- data/sig/orb/models/customers/credits/top_up_create_by_external_id_response.rbs +0 -4
- data/sig/orb/models/customers/credits/top_up_create_params.rbs +3 -7
- data/sig/orb/models/customers/credits/top_up_create_response.rbs +0 -4
- data/sig/orb/models/customers/credits/top_up_delete_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/credits/top_up_delete_params.rbs +0 -2
- data/sig/orb/models/customers/credits/top_up_list_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/credits/top_up_list_by_external_id_response.rbs +0 -4
- data/sig/orb/models/customers/credits/top_up_list_params.rbs +0 -2
- data/sig/orb/models/customers/credits/top_up_list_response.rbs +0 -4
- data/sig/orb/models/dimensional_price_group.rbs +0 -2
- data/sig/orb/models/dimensional_price_group_create_params.rbs +0 -2
- data/sig/orb/models/dimensional_price_group_list_params.rbs +0 -2
- data/sig/orb/models/dimensional_price_group_retrieve_params.rbs +0 -2
- data/sig/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbs +0 -2
- data/sig/orb/models/dimensional_price_groups.rbs +6 -8
- data/sig/orb/models/discount.rbs +5 -5
- data/sig/orb/models/evaluate_price_group.rbs +4 -6
- data/sig/orb/models/event_deprecate_params.rbs +0 -2
- data/sig/orb/models/event_deprecate_response.rbs +0 -2
- data/sig/orb/models/event_ingest_params.rbs +3 -7
- data/sig/orb/models/event_ingest_response.rbs +0 -6
- data/sig/orb/models/event_search_params.rbs +0 -2
- data/sig/orb/models/event_search_response.rbs +0 -4
- data/sig/orb/models/event_update_params.rbs +0 -2
- data/sig/orb/models/event_update_response.rbs +0 -2
- data/sig/orb/models/events/backfill_close_params.rbs +0 -2
- data/sig/orb/models/events/backfill_close_response.rbs +0 -2
- data/sig/orb/models/events/backfill_create_params.rbs +0 -2
- data/sig/orb/models/events/backfill_create_response.rbs +0 -2
- data/sig/orb/models/events/backfill_fetch_params.rbs +0 -2
- data/sig/orb/models/events/backfill_fetch_response.rbs +0 -2
- data/sig/orb/models/events/backfill_list_params.rbs +0 -2
- data/sig/orb/models/events/backfill_list_response.rbs +0 -2
- data/sig/orb/models/events/backfill_revert_params.rbs +0 -2
- data/sig/orb/models/events/backfill_revert_response.rbs +0 -2
- data/sig/orb/models/events/event_volumes.rbs +3 -10
- data/sig/orb/models/events/volume_list_params.rbs +0 -2
- data/sig/orb/models/invoice.rbs +126 -188
- data/sig/orb/models/invoice_create_params.rbs +10 -16
- data/sig/orb/models/invoice_fetch_params.rbs +0 -2
- data/sig/orb/models/invoice_fetch_upcoming_params.rbs +0 -2
- data/sig/orb/models/invoice_fetch_upcoming_response.rbs +41 -103
- data/sig/orb/models/invoice_issue_params.rbs +0 -2
- data/sig/orb/models/invoice_level_discount.rbs +2 -4
- data/sig/orb/models/invoice_line_item_create_params.rbs +0 -2
- data/sig/orb/models/invoice_line_item_create_response.rbs +41 -75
- data/sig/orb/models/invoice_list_params.rbs +4 -6
- data/sig/orb/models/invoice_mark_paid_params.rbs +0 -2
- data/sig/orb/models/invoice_pay_params.rbs +0 -2
- data/sig/orb/models/invoice_update_params.rbs +0 -2
- data/sig/orb/models/invoice_void_params.rbs +0 -2
- data/sig/orb/models/item.rbs +7 -11
- data/sig/orb/models/item_create_params.rbs +0 -2
- data/sig/orb/models/item_fetch_params.rbs +0 -2
- data/sig/orb/models/item_list_params.rbs +0 -2
- data/sig/orb/models/item_update_params.rbs +7 -11
- data/sig/orb/models/metric_create_params.rbs +0 -2
- data/sig/orb/models/metric_fetch_params.rbs +0 -2
- data/sig/orb/models/metric_list_params.rbs +0 -2
- data/sig/orb/models/metric_update_params.rbs +0 -2
- data/sig/orb/models/pagination_metadata.rbs +0 -2
- data/sig/orb/models/percentage_discount.rbs +4 -6
- data/sig/orb/models/plan.rbs +55 -83
- data/sig/orb/models/plan_create_params.rbs +568 -746
- data/sig/orb/models/plan_fetch_params.rbs +0 -2
- data/sig/orb/models/plan_list_params.rbs +0 -2
- data/sig/orb/models/plan_update_params.rbs +0 -2
- data/sig/orb/models/plans/external_plan_id_fetch_params.rbs +0 -2
- data/sig/orb/models/plans/external_plan_id_update_params.rbs +0 -2
- data/sig/orb/models/price.rbs +1250 -1790
- data/sig/orb/models/price_create_params.rbs +59 -97
- data/sig/orb/models/price_evaluate_params.rbs +0 -2
- data/sig/orb/models/price_evaluate_response.rbs +3 -6
- data/sig/orb/models/price_fetch_params.rbs +0 -2
- data/sig/orb/models/price_list_params.rbs +0 -2
- data/sig/orb/models/price_update_params.rbs +0 -2
- data/sig/orb/models/prices/external_price_id_fetch_params.rbs +0 -2
- data/sig/orb/models/prices/external_price_id_update_params.rbs +0 -2
- data/sig/orb/models/subscription.rbs +72 -110
- data/sig/orb/models/subscription_cancel_params.rbs +0 -2
- data/sig/orb/models/subscription_cancel_response.rbs +44 -84
- data/sig/orb/models/subscription_change_apply_params.rbs +0 -2
- data/sig/orb/models/subscription_change_apply_response.rbs +44 -86
- data/sig/orb/models/subscription_change_cancel_params.rbs +0 -2
- data/sig/orb/models/subscription_change_cancel_response.rbs +44 -86
- data/sig/orb/models/subscription_change_retrieve_params.rbs +0 -2
- data/sig/orb/models/subscription_change_retrieve_response.rbs +44 -86
- data/sig/orb/models/subscription_create_params.rbs +1223 -1619
- data/sig/orb/models/subscription_create_response.rbs +44 -84
- data/sig/orb/models/subscription_fetch_costs_params.rbs +0 -2
- data/sig/orb/models/subscription_fetch_costs_response.rbs +0 -6
- data/sig/orb/models/subscription_fetch_params.rbs +0 -2
- data/sig/orb/models/subscription_fetch_schedule_params.rbs +0 -2
- data/sig/orb/models/subscription_fetch_schedule_response.rbs +0 -4
- data/sig/orb/models/subscription_fetch_usage_params.rbs +0 -2
- data/sig/orb/models/subscription_list_params.rbs +0 -2
- data/sig/orb/models/subscription_price_intervals_params.rbs +738 -970
- data/sig/orb/models/subscription_price_intervals_response.rbs +44 -84
- data/sig/orb/models/subscription_schedule_plan_change_params.rbs +1223 -1619
- data/sig/orb/models/subscription_schedule_plan_change_response.rbs +44 -84
- data/sig/orb/models/subscription_trigger_phase_params.rbs +0 -2
- data/sig/orb/models/subscription_trigger_phase_response.rbs +44 -84
- data/sig/orb/models/subscription_unschedule_cancellation_params.rbs +0 -2
- data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +44 -84
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbs +0 -2
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +44 -84
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_params.rbs +0 -2
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +44 -84
- data/sig/orb/models/subscription_update_fixed_fee_quantity_params.rbs +0 -2
- data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +44 -84
- data/sig/orb/models/subscription_update_params.rbs +0 -2
- data/sig/orb/models/subscription_update_trial_params.rbs +1 -3
- data/sig/orb/models/subscription_update_trial_response.rbs +44 -84
- data/sig/orb/models/subscription_usage.rbs +35 -53
- data/sig/orb/models/subscriptions.rbs +6 -8
- data/sig/orb/models/top_level_ping_params.rbs +0 -2
- data/sig/orb/models/top_level_ping_response.rbs +0 -2
- data/sig/orb/models/trial_discount.rbs +4 -6
- data/sig/orb/models/usage_discount.rbs +4 -6
- data/sig/orb/models.rbs +215 -0
- data/sig/orb/request_options.rbs +1 -1
- data/sig/orb/resources/alerts.rbs +12 -12
- data/sig/orb/resources/coupons/subscriptions.rbs +1 -1
- data/sig/orb/resources/coupons.rbs +4 -4
- data/sig/orb/resources/credit_notes.rbs +4 -4
- data/sig/orb/resources/customers/credits/ledger.rbs +2 -2
- data/sig/orb/resources/customers/credits/top_ups.rbs +2 -2
- data/sig/orb/resources/customers.rbs +24 -24
- data/sig/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbs +1 -1
- data/sig/orb/resources/dimensional_price_groups.rbs +3 -3
- data/sig/orb/resources/events/volume.rbs +1 -1
- data/sig/orb/resources/events.rbs +1 -1
- data/sig/orb/resources/invoices.rbs +10 -10
- data/sig/orb/resources/items.rbs +5 -5
- data/sig/orb/resources/metrics.rbs +4 -4
- data/sig/orb/resources/plans/external_plan_id.rbs +2 -2
- data/sig/orb/resources/plans.rbs +5 -5
- data/sig/orb/resources/prices.rbs +11 -11
- data/sig/orb/resources/subscriptions.rbs +21 -21
- metadata +226 -223
- data/rbi/lib/orb/internal/type/array_of.rbi +0 -90
- data/rbi/lib/orb/internal/type/request_parameters.rbi +0 -21
- data/rbi/lib/orb/internal/type/union.rbi +0 -75
- data/rbi/lib/orb/internal/type/unknown.rbi +0 -42
- data/rbi/lib/orb/internal/util.rbi +0 -299
- data/rbi/lib/orb/models/alert_retrieve_params.rbi +0 -18
- data/rbi/lib/orb/models/billing_cycle_relative_date.rbi +0 -18
- data/rbi/lib/orb/models/coupon_archive_params.rbi +0 -18
- data/rbi/lib/orb/models/coupon_fetch_params.rbi +0 -18
- data/rbi/lib/orb/models/credit_note_create_params.rbi +0 -88
- data/rbi/lib/orb/models/credit_note_fetch_params.rbi +0 -18
- data/rbi/lib/orb/models/customer_delete_params.rbi +0 -18
- data/rbi/lib/orb/models/customer_fetch_by_external_id_params.rbi +0 -18
- data/rbi/lib/orb/models/customer_fetch_params.rbi +0 -18
- data/rbi/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +0 -18
- data/rbi/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rbi +0 -18
- data/rbi/lib/orb/models/customers/balance_transaction_create_params.rbi +0 -65
- data/rbi/lib/orb/models/customers/balance_transaction_create_response.rbi +0 -208
- data/rbi/lib/orb/models/customers/balance_transaction_list_response.rbi +0 -196
- data/rbi/lib/orb/models/customers/cost_list_by_external_id_response.rbi +0 -225
- data/rbi/lib/orb/models/customers/cost_list_response.rbi +0 -223
- data/rbi/lib/orb/models/customers/credit_list_by_external_id_response.rbi +0 -84
- data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +0 -166
- data/rbi/lib/orb/models/customers/credits/ledger_list_params.rbi +0 -141
- data/rbi/lib/orb/models/customers/credits/top_up_delete_params.rbi +0 -26
- data/rbi/lib/orb/models/dimensional_price_group_retrieve_params.rbi +0 -18
- data/rbi/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +0 -25
- data/rbi/lib/orb/models/dimensional_price_groups.rbi +0 -33
- data/rbi/lib/orb/models/discount.rbi +0 -17
- data/rbi/lib/orb/models/event_deprecate_params.rbi +0 -18
- data/rbi/lib/orb/models/events/backfill_close_params.rbi +0 -25
- data/rbi/lib/orb/models/events/backfill_fetch_params.rbi +0 -25
- data/rbi/lib/orb/models/events/backfill_revert_params.rbi +0 -25
- data/rbi/lib/orb/models/invoice_fetch_params.rbi +0 -18
- data/rbi/lib/orb/models/invoice_fetch_upcoming_params.rbi +0 -22
- data/rbi/lib/orb/models/invoice_level_discount.rbi +0 -15
- data/rbi/lib/orb/models/invoice_pay_params.rbi +0 -18
- data/rbi/lib/orb/models/invoice_void_params.rbi +0 -18
- data/rbi/lib/orb/models/item.rbi +0 -95
- data/rbi/lib/orb/models/item_fetch_params.rbi +0 -18
- data/rbi/lib/orb/models/item_update_params.rbi +0 -101
- data/rbi/lib/orb/models/metric_fetch_params.rbi +0 -18
- data/rbi/lib/orb/models/pagination_metadata.rbi +0 -19
- data/rbi/lib/orb/models/plan_fetch_params.rbi +0 -18
- data/rbi/lib/orb/models/plans/external_plan_id_fetch_params.rbi +0 -25
- data/rbi/lib/orb/models/price.rbi +0 -14861
- data/rbi/lib/orb/models/price_evaluate_response.rbi +0 -19
- data/rbi/lib/orb/models/price_fetch_params.rbi +0 -18
- data/rbi/lib/orb/models/prices/external_price_id_fetch_params.rbi +0 -25
- data/rbi/lib/orb/models/subscription_change_cancel_params.rbi +0 -18
- data/rbi/lib/orb/models/subscription_change_retrieve_params.rbi +0 -18
- data/rbi/lib/orb/models/subscription_fetch_costs_response.rbi +0 -221
- data/rbi/lib/orb/models/subscription_fetch_params.rbi +0 -18
- data/rbi/lib/orb/models/subscription_unschedule_cancellation_params.rbi +0 -18
- data/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rbi +0 -18
- data/rbi/lib/orb/models/subscription_update_trial_params.rbi +0 -66
- data/rbi/lib/orb/models/subscription_usage.rbi +0 -296
- data/rbi/lib/orb/models/subscriptions.rbi +0 -31
- data/rbi/lib/orb/models/top_level_ping_params.rbi +0 -18
- data/rbi/lib/orb/resources/prices/external_price_id.rbi +0 -106
- /data/rbi/{lib/orb → orb}/internal.rbi +0 -0
- /data/rbi/{lib/orb → orb}/version.rbi +0 -0
data/lib/orb/models/invoice.rb
CHANGED
@@ -18,13 +18,13 @@ module Orb
|
|
18
18
|
|
19
19
|
# @!attribute auto_collection
|
20
20
|
#
|
21
|
-
# @return [Orb::
|
22
|
-
required :auto_collection, -> { Orb::
|
21
|
+
# @return [Orb::Invoice::AutoCollection]
|
22
|
+
required :auto_collection, -> { Orb::Invoice::AutoCollection }
|
23
23
|
|
24
24
|
# @!attribute billing_address
|
25
25
|
#
|
26
|
-
# @return [Orb::
|
27
|
-
required :billing_address, -> { Orb::
|
26
|
+
# @return [Orb::Invoice::BillingAddress, nil]
|
27
|
+
required :billing_address, -> { Orb::Invoice::BillingAddress }, nil?: true
|
28
28
|
|
29
29
|
# @!attribute created_at
|
30
30
|
# The creation time of the resource in Orb.
|
@@ -35,8 +35,8 @@ module Orb
|
|
35
35
|
# @!attribute credit_notes
|
36
36
|
# A list of credit notes associated with the invoice
|
37
37
|
#
|
38
|
-
# @return [Array<Orb::
|
39
|
-
required :credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::
|
38
|
+
# @return [Array<Orb::Invoice::CreditNote>]
|
39
|
+
required :credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::Invoice::CreditNote] }
|
40
40
|
|
41
41
|
# @!attribute currency
|
42
42
|
# An ISO 4217 currency string or `credits`
|
@@ -46,14 +46,14 @@ module Orb
|
|
46
46
|
|
47
47
|
# @!attribute customer
|
48
48
|
#
|
49
|
-
# @return [Orb::
|
50
|
-
required :customer, -> { Orb::
|
49
|
+
# @return [Orb::Invoice::Customer]
|
50
|
+
required :customer, -> { Orb::Invoice::Customer }
|
51
51
|
|
52
52
|
# @!attribute customer_balance_transactions
|
53
53
|
#
|
54
|
-
# @return [Array<Orb::
|
54
|
+
# @return [Array<Orb::Invoice::CustomerBalanceTransaction>]
|
55
55
|
required :customer_balance_transactions,
|
56
|
-
-> { Orb::Internal::Type::ArrayOf[Orb::
|
56
|
+
-> { Orb::Internal::Type::ArrayOf[Orb::Invoice::CustomerBalanceTransaction] }
|
57
57
|
|
58
58
|
# @!attribute customer_tax_id
|
59
59
|
# Tax IDs are commonly required to be displayed on customer invoices, which are
|
@@ -162,8 +162,8 @@ module Orb
|
|
162
162
|
# | Venezuela | `ve_rif` | Venezuelan RIF Number |
|
163
163
|
# | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
|
164
164
|
#
|
165
|
-
# @return [Orb::
|
166
|
-
required :customer_tax_id, -> { Orb::
|
165
|
+
# @return [Orb::Invoice::CustomerTaxID, nil]
|
166
|
+
required :customer_tax_id, -> { Orb::Invoice::CustomerTaxID }, nil?: true
|
167
167
|
|
168
168
|
# @!attribute discount
|
169
169
|
# @deprecated
|
@@ -177,8 +177,8 @@ module Orb
|
|
177
177
|
|
178
178
|
# @!attribute discounts
|
179
179
|
#
|
180
|
-
# @return [Array<Orb::
|
181
|
-
required :discounts, -> { Orb::Internal::Type::ArrayOf[union: Orb::
|
180
|
+
# @return [Array<Orb::PercentageDiscount, Orb::AmountDiscount, Orb::TrialDiscount>]
|
181
|
+
required :discounts, -> { Orb::Internal::Type::ArrayOf[union: Orb::InvoiceLevelDiscount] }
|
182
182
|
|
183
183
|
# @!attribute due_date
|
184
184
|
# When the invoice payment is due. The due date is null if the invoice is not yet
|
@@ -224,8 +224,8 @@ module Orb
|
|
224
224
|
|
225
225
|
# @!attribute invoice_source
|
226
226
|
#
|
227
|
-
# @return [Symbol, Orb::
|
228
|
-
required :invoice_source, enum: -> { Orb::
|
227
|
+
# @return [Symbol, Orb::Invoice::InvoiceSource]
|
228
|
+
required :invoice_source, enum: -> { Orb::Invoice::InvoiceSource }
|
229
229
|
|
230
230
|
# @!attribute issue_failed_at
|
231
231
|
# If the invoice failed to issue, this will be the last time it failed to issue
|
@@ -244,13 +244,13 @@ module Orb
|
|
244
244
|
# @!attribute line_items
|
245
245
|
# The breakdown of prices in this invoice.
|
246
246
|
#
|
247
|
-
# @return [Array<Orb::
|
248
|
-
required :line_items, -> { Orb::Internal::Type::ArrayOf[Orb::
|
247
|
+
# @return [Array<Orb::Invoice::LineItem>]
|
248
|
+
required :line_items, -> { Orb::Internal::Type::ArrayOf[Orb::Invoice::LineItem] }
|
249
249
|
|
250
250
|
# @!attribute maximum
|
251
251
|
#
|
252
|
-
# @return [Orb::
|
253
|
-
required :maximum, -> { Orb::
|
252
|
+
# @return [Orb::Invoice::Maximum, nil]
|
253
|
+
required :maximum, -> { Orb::Invoice::Maximum }, nil?: true
|
254
254
|
|
255
255
|
# @!attribute maximum_amount
|
256
256
|
#
|
@@ -274,8 +274,8 @@ module Orb
|
|
274
274
|
|
275
275
|
# @!attribute minimum
|
276
276
|
#
|
277
|
-
# @return [Orb::
|
278
|
-
required :minimum, -> { Orb::
|
277
|
+
# @return [Orb::Invoice::Minimum, nil]
|
278
|
+
required :minimum, -> { Orb::Invoice::Minimum }, nil?: true
|
279
279
|
|
280
280
|
# @!attribute minimum_amount
|
281
281
|
#
|
@@ -292,8 +292,8 @@ module Orb
|
|
292
292
|
# @!attribute payment_attempts
|
293
293
|
# A list of payment attempts associated with the invoice
|
294
294
|
#
|
295
|
-
# @return [Array<Orb::
|
296
|
-
required :payment_attempts, -> { Orb::Internal::Type::ArrayOf[Orb::
|
295
|
+
# @return [Array<Orb::Invoice::PaymentAttempt>]
|
296
|
+
required :payment_attempts, -> { Orb::Internal::Type::ArrayOf[Orb::Invoice::PaymentAttempt] }
|
297
297
|
|
298
298
|
# @!attribute payment_failed_at
|
299
299
|
# If payment was attempted on this invoice but failed, this will be the time of
|
@@ -319,18 +319,18 @@ module Orb
|
|
319
319
|
|
320
320
|
# @!attribute shipping_address
|
321
321
|
#
|
322
|
-
# @return [Orb::
|
323
|
-
required :shipping_address, -> { Orb::
|
322
|
+
# @return [Orb::Invoice::ShippingAddress, nil]
|
323
|
+
required :shipping_address, -> { Orb::Invoice::ShippingAddress }, nil?: true
|
324
324
|
|
325
325
|
# @!attribute status
|
326
326
|
#
|
327
|
-
# @return [Symbol, Orb::
|
328
|
-
required :status, enum: -> { Orb::
|
327
|
+
# @return [Symbol, Orb::Invoice::Status]
|
328
|
+
required :status, enum: -> { Orb::Invoice::Status }
|
329
329
|
|
330
330
|
# @!attribute subscription
|
331
331
|
#
|
332
|
-
# @return [Orb::
|
333
|
-
required :subscription, -> { Orb::
|
332
|
+
# @return [Orb::Invoice::Subscription, nil]
|
333
|
+
required :subscription, -> { Orb::Invoice::Subscription }, nil?: true
|
334
334
|
|
335
335
|
# @!attribute subtotal
|
336
336
|
# The total before any discounts and minimums are applied.
|
@@ -367,8 +367,8 @@ module Orb
|
|
367
367
|
required :will_auto_issue, Orb::Internal::Type::Boolean
|
368
368
|
|
369
369
|
# @!method initialize(id:, amount_due:, auto_collection:, billing_address:, created_at:, credit_notes:, currency:, customer:, customer_balance_transactions:, customer_tax_id:, discount:, discounts:, due_date:, eligible_to_issue_at:, hosted_invoice_url:, invoice_date:, invoice_number:, invoice_pdf:, invoice_source:, issue_failed_at:, issued_at:, line_items:, maximum:, maximum_amount:, memo:, metadata:, minimum:, minimum_amount:, paid_at:, payment_attempts:, payment_failed_at:, payment_started_at:, scheduled_issue_at:, shipping_address:, status:, subscription:, subtotal:, sync_failed_at:, total:, voided_at:, will_auto_issue:)
|
370
|
-
# Some parameter documentations has been truncated, see {Orb::
|
371
|
-
#
|
370
|
+
# Some parameter documentations has been truncated, see {Orb::Invoice} for more
|
371
|
+
# details.
|
372
372
|
#
|
373
373
|
# An [`Invoice`](/core-concepts#invoice) is a fundamental billing entity,
|
374
374
|
# representing the request for payment for a single subscription. This includes a
|
@@ -379,104 +379,86 @@ module Orb
|
|
379
379
|
# @param id [String]
|
380
380
|
#
|
381
381
|
# @param amount_due [String] This is the final amount required to be charged to the customer and reflects the
|
382
|
-
# ...
|
383
382
|
#
|
384
|
-
# @param auto_collection [Orb::
|
383
|
+
# @param auto_collection [Orb::Invoice::AutoCollection]
|
385
384
|
#
|
386
|
-
# @param billing_address [Orb::
|
385
|
+
# @param billing_address [Orb::Invoice::BillingAddress, nil]
|
387
386
|
#
|
388
387
|
# @param created_at [Time] The creation time of the resource in Orb.
|
389
388
|
#
|
390
|
-
# @param credit_notes [Array<Orb::
|
389
|
+
# @param credit_notes [Array<Orb::Invoice::CreditNote>] A list of credit notes associated with the invoice
|
391
390
|
#
|
392
391
|
# @param currency [String] An ISO 4217 currency string or `credits`
|
393
392
|
#
|
394
|
-
# @param customer [Orb::
|
393
|
+
# @param customer [Orb::Invoice::Customer]
|
395
394
|
#
|
396
|
-
# @param customer_balance_transactions [Array<Orb::
|
395
|
+
# @param customer_balance_transactions [Array<Orb::Invoice::CustomerBalanceTransaction>]
|
397
396
|
#
|
398
|
-
# @param customer_tax_id [Orb::
|
399
|
-
# ...
|
397
|
+
# @param customer_tax_id [Orb::Invoice::CustomerTaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad
|
400
398
|
#
|
401
399
|
# @param discount [Object] This field is deprecated in favor of `discounts`. If a `discounts` list is provi
|
402
|
-
# ...
|
403
400
|
#
|
404
|
-
# @param discounts [Array<Orb::
|
401
|
+
# @param discounts [Array<Orb::PercentageDiscount, Orb::AmountDiscount, Orb::TrialDiscount>]
|
405
402
|
#
|
406
403
|
# @param due_date [Time, nil] When the invoice payment is due. The due date is null if the invoice is not yet
|
407
|
-
# ...
|
408
404
|
#
|
409
405
|
# @param eligible_to_issue_at [Time, nil] If the invoice has a status of `draft`, this will be the time that the invoice w
|
410
|
-
# ...
|
411
406
|
#
|
412
407
|
# @param hosted_invoice_url [String, nil] A URL for the customer-facing invoice portal. This URL expires 30 days after the
|
413
|
-
# ...
|
414
408
|
#
|
415
409
|
# @param invoice_date [Time] The scheduled date of the invoice
|
416
410
|
#
|
417
411
|
# @param invoice_number [String] Automatically generated invoice number to help track and reconcile invoices. Inv
|
418
|
-
# ...
|
419
412
|
#
|
420
413
|
# @param invoice_pdf [String, nil] The link to download the PDF representation of the `Invoice`.
|
421
414
|
#
|
422
|
-
# @param invoice_source [Symbol, Orb::
|
415
|
+
# @param invoice_source [Symbol, Orb::Invoice::InvoiceSource]
|
423
416
|
#
|
424
417
|
# @param issue_failed_at [Time, nil] If the invoice failed to issue, this will be the last time it failed to issue (e
|
425
|
-
# ...
|
426
418
|
#
|
427
419
|
# @param issued_at [Time, nil] If the invoice has been issued, this will be the time it transitioned to `issued
|
428
|
-
# ...
|
429
420
|
#
|
430
|
-
# @param line_items [Array<Orb::
|
421
|
+
# @param line_items [Array<Orb::Invoice::LineItem>] The breakdown of prices in this invoice.
|
431
422
|
#
|
432
|
-
# @param maximum [Orb::
|
423
|
+
# @param maximum [Orb::Invoice::Maximum, nil]
|
433
424
|
#
|
434
425
|
# @param maximum_amount [String, nil]
|
435
426
|
#
|
436
427
|
# @param memo [String, nil] Free-form text which is available on the invoice PDF and the Orb invoice portal.
|
437
|
-
# ...
|
438
428
|
#
|
439
429
|
# @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
|
440
|
-
# ...
|
441
430
|
#
|
442
|
-
# @param minimum [Orb::
|
431
|
+
# @param minimum [Orb::Invoice::Minimum, nil]
|
443
432
|
#
|
444
433
|
# @param minimum_amount [String, nil]
|
445
434
|
#
|
446
435
|
# @param paid_at [Time, nil] If the invoice has a status of `paid`, this gives a timestamp when the invoice w
|
447
|
-
# ...
|
448
436
|
#
|
449
|
-
# @param payment_attempts [Array<Orb::
|
437
|
+
# @param payment_attempts [Array<Orb::Invoice::PaymentAttempt>] A list of payment attempts associated with the invoice
|
450
438
|
#
|
451
439
|
# @param payment_failed_at [Time, nil] If payment was attempted on this invoice but failed, this will be the time of th
|
452
|
-
# ...
|
453
440
|
#
|
454
441
|
# @param payment_started_at [Time, nil] If payment was attempted on this invoice, this will be the start time of the mos
|
455
|
-
# ...
|
456
442
|
#
|
457
443
|
# @param scheduled_issue_at [Time, nil] If the invoice is in draft, this timestamp will reflect when the invoice is sche
|
458
|
-
# ...
|
459
444
|
#
|
460
|
-
# @param shipping_address [Orb::
|
445
|
+
# @param shipping_address [Orb::Invoice::ShippingAddress, nil]
|
461
446
|
#
|
462
|
-
# @param status [Symbol, Orb::
|
447
|
+
# @param status [Symbol, Orb::Invoice::Status]
|
463
448
|
#
|
464
|
-
# @param subscription [Orb::
|
449
|
+
# @param subscription [Orb::Invoice::Subscription, nil]
|
465
450
|
#
|
466
451
|
# @param subtotal [String] The total before any discounts and minimums are applied.
|
467
452
|
#
|
468
453
|
# @param sync_failed_at [Time, nil] If the invoice failed to sync, this will be the last time an external invoicing
|
469
|
-
# ...
|
470
454
|
#
|
471
455
|
# @param total [String] The total after any minimums and discounts have been applied.
|
472
456
|
#
|
473
457
|
# @param voided_at [Time, nil] If the invoice has a status of `void`, this gives a timestamp when the invoice w
|
474
|
-
# ...
|
475
458
|
#
|
476
459
|
# @param will_auto_issue [Boolean] This is true if the invoice will be automatically issued in the future, and fals
|
477
|
-
# ...
|
478
460
|
|
479
|
-
# @see Orb::
|
461
|
+
# @see Orb::Invoice#auto_collection
|
480
462
|
class AutoCollection < Orb::Internal::Type::BaseModel
|
481
463
|
# @!attribute enabled
|
482
464
|
# True only if auto-collection is enabled for this invoice.
|
@@ -511,20 +493,18 @@ module Orb
|
|
511
493
|
|
512
494
|
# @!method initialize(enabled:, next_attempt_at:, num_attempts:, previously_attempted_at:)
|
513
495
|
# Some parameter documentations has been truncated, see
|
514
|
-
# {Orb::
|
496
|
+
# {Orb::Invoice::AutoCollection} for more details.
|
515
497
|
#
|
516
498
|
# @param enabled [Boolean, nil] True only if auto-collection is enabled for this invoice.
|
517
499
|
#
|
518
500
|
# @param next_attempt_at [Time, nil] If the invoice is scheduled for auto-collection, this field will reflect when th
|
519
|
-
# ...
|
520
501
|
#
|
521
502
|
# @param num_attempts [Integer, nil] Number of auto-collection payment attempts.
|
522
503
|
#
|
523
504
|
# @param previously_attempted_at [Time, nil] If Orb has ever attempted payment auto-collection for this invoice, this field w
|
524
|
-
# ...
|
525
505
|
end
|
526
506
|
|
527
|
-
# @see Orb::
|
507
|
+
# @see Orb::Invoice#billing_address
|
528
508
|
class BillingAddress < Orb::Internal::Type::BaseModel
|
529
509
|
# @!attribute city
|
530
510
|
#
|
@@ -605,8 +585,8 @@ module Orb
|
|
605
585
|
required :voided_at, Time, nil?: true
|
606
586
|
|
607
587
|
# @!method initialize(id:, credit_note_number:, memo:, reason:, total:, type:, voided_at:)
|
608
|
-
# Some parameter documentations has been truncated, see
|
609
|
-
#
|
588
|
+
# Some parameter documentations has been truncated, see {Orb::Invoice::CreditNote}
|
589
|
+
# for more details.
|
610
590
|
#
|
611
591
|
# @param id [String]
|
612
592
|
#
|
@@ -621,10 +601,9 @@ module Orb
|
|
621
601
|
# @param type [String]
|
622
602
|
#
|
623
603
|
# @param voided_at [Time, nil] If the credit note has a status of `void`, this gives a timestamp when the credi
|
624
|
-
# ...
|
625
604
|
end
|
626
605
|
|
627
|
-
# @see Orb::
|
606
|
+
# @see Orb::Invoice#customer
|
628
607
|
class Customer < Orb::Internal::Type::BaseModel
|
629
608
|
# @!attribute id
|
630
609
|
#
|
@@ -650,8 +629,8 @@ module Orb
|
|
650
629
|
|
651
630
|
# @!attribute action
|
652
631
|
#
|
653
|
-
# @return [Symbol, Orb::
|
654
|
-
required :action, enum: -> { Orb::
|
632
|
+
# @return [Symbol, Orb::Invoice::CustomerBalanceTransaction::Action]
|
633
|
+
required :action, enum: -> { Orb::Invoice::CustomerBalanceTransaction::Action }
|
655
634
|
|
656
635
|
# @!attribute amount
|
657
636
|
# The value of the amount changed in the transaction.
|
@@ -667,8 +646,8 @@ module Orb
|
|
667
646
|
|
668
647
|
# @!attribute credit_note
|
669
648
|
#
|
670
|
-
# @return [Orb::
|
671
|
-
required :credit_note, -> { Orb::
|
649
|
+
# @return [Orb::Invoice::CustomerBalanceTransaction::CreditNote, nil]
|
650
|
+
required :credit_note, -> { Orb::Invoice::CustomerBalanceTransaction::CreditNote }, nil?: true
|
672
651
|
|
673
652
|
# @!attribute description
|
674
653
|
# An optional description provided for manual customer balance adjustments.
|
@@ -685,8 +664,8 @@ module Orb
|
|
685
664
|
|
686
665
|
# @!attribute invoice
|
687
666
|
#
|
688
|
-
# @return [Orb::
|
689
|
-
required :invoice, -> { Orb::
|
667
|
+
# @return [Orb::Invoice::CustomerBalanceTransaction::Invoice, nil]
|
668
|
+
required :invoice, -> { Orb::Invoice::CustomerBalanceTransaction::Invoice }, nil?: true
|
690
669
|
|
691
670
|
# @!attribute starting_balance
|
692
671
|
# The original value of the customer's balance prior to the transaction, in the
|
@@ -697,36 +676,34 @@ module Orb
|
|
697
676
|
|
698
677
|
# @!attribute type
|
699
678
|
#
|
700
|
-
# @return [Symbol, Orb::
|
701
|
-
required :type, enum: -> { Orb::
|
679
|
+
# @return [Symbol, Orb::Invoice::CustomerBalanceTransaction::Type]
|
680
|
+
required :type, enum: -> { Orb::Invoice::CustomerBalanceTransaction::Type }
|
702
681
|
|
703
682
|
# @!method initialize(id:, action:, amount:, created_at:, credit_note:, description:, ending_balance:, invoice:, starting_balance:, type:)
|
704
683
|
# Some parameter documentations has been truncated, see
|
705
|
-
# {Orb::
|
684
|
+
# {Orb::Invoice::CustomerBalanceTransaction} for more details.
|
706
685
|
#
|
707
686
|
# @param id [String] A unique id for this transaction.
|
708
687
|
#
|
709
|
-
# @param action [Symbol, Orb::
|
688
|
+
# @param action [Symbol, Orb::Invoice::CustomerBalanceTransaction::Action]
|
710
689
|
#
|
711
690
|
# @param amount [String] The value of the amount changed in the transaction.
|
712
691
|
#
|
713
692
|
# @param created_at [Time] The creation time of this transaction.
|
714
693
|
#
|
715
|
-
# @param credit_note [Orb::
|
694
|
+
# @param credit_note [Orb::Invoice::CustomerBalanceTransaction::CreditNote, nil]
|
716
695
|
#
|
717
696
|
# @param description [String, nil] An optional description provided for manual customer balance adjustments.
|
718
697
|
#
|
719
698
|
# @param ending_balance [String] The new value of the customer's balance prior to the transaction, in the custome
|
720
|
-
# ...
|
721
699
|
#
|
722
|
-
# @param invoice [Orb::
|
700
|
+
# @param invoice [Orb::Invoice::CustomerBalanceTransaction::Invoice, nil]
|
723
701
|
#
|
724
702
|
# @param starting_balance [String] The original value of the customer's balance prior to the transaction, in the cu
|
725
|
-
# ...
|
726
703
|
#
|
727
|
-
# @param type [Symbol, Orb::
|
704
|
+
# @param type [Symbol, Orb::Invoice::CustomerBalanceTransaction::Type]
|
728
705
|
|
729
|
-
# @see Orb::
|
706
|
+
# @see Orb::Invoice::CustomerBalanceTransaction#action
|
730
707
|
module Action
|
731
708
|
extend Orb::Internal::Type::Enum
|
732
709
|
|
@@ -744,7 +721,7 @@ module Orb
|
|
744
721
|
# @return [Array<Symbol>]
|
745
722
|
end
|
746
723
|
|
747
|
-
# @see Orb::
|
724
|
+
# @see Orb::Invoice::CustomerBalanceTransaction#credit_note
|
748
725
|
class CreditNote < Orb::Internal::Type::BaseModel
|
749
726
|
# @!attribute id
|
750
727
|
# The id of the Credit note
|
@@ -756,7 +733,7 @@ module Orb
|
|
756
733
|
# @param id [String] The id of the Credit note
|
757
734
|
end
|
758
735
|
|
759
|
-
# @see Orb::
|
736
|
+
# @see Orb::Invoice::CustomerBalanceTransaction#invoice
|
760
737
|
class Invoice < Orb::Internal::Type::BaseModel
|
761
738
|
# @!attribute id
|
762
739
|
# The Invoice id
|
@@ -768,7 +745,7 @@ module Orb
|
|
768
745
|
# @param id [String] The Invoice id
|
769
746
|
end
|
770
747
|
|
771
|
-
# @see Orb::
|
748
|
+
# @see Orb::Invoice::CustomerBalanceTransaction#type
|
772
749
|
module Type
|
773
750
|
extend Orb::Internal::Type::Enum
|
774
751
|
|
@@ -780,17 +757,17 @@ module Orb
|
|
780
757
|
end
|
781
758
|
end
|
782
759
|
|
783
|
-
# @see Orb::
|
760
|
+
# @see Orb::Invoice#customer_tax_id
|
784
761
|
class CustomerTaxID < Orb::Internal::Type::BaseModel
|
785
762
|
# @!attribute country
|
786
763
|
#
|
787
|
-
# @return [Symbol, Orb::
|
788
|
-
required :country, enum: -> { Orb::
|
764
|
+
# @return [Symbol, Orb::Invoice::CustomerTaxID::Country]
|
765
|
+
required :country, enum: -> { Orb::Invoice::CustomerTaxID::Country }
|
789
766
|
|
790
767
|
# @!attribute type
|
791
768
|
#
|
792
|
-
# @return [Symbol, Orb::
|
793
|
-
required :type, enum: -> { Orb::
|
769
|
+
# @return [Symbol, Orb::Invoice::CustomerTaxID::Type]
|
770
|
+
required :type, enum: -> { Orb::Invoice::CustomerTaxID::Type }
|
794
771
|
|
795
772
|
# @!attribute value
|
796
773
|
#
|
@@ -904,11 +881,11 @@ module Orb
|
|
904
881
|
# | Venezuela | `ve_rif` | Venezuelan RIF Number |
|
905
882
|
# | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
|
906
883
|
#
|
907
|
-
# @param country [Symbol, Orb::
|
908
|
-
# @param type [Symbol, Orb::
|
884
|
+
# @param country [Symbol, Orb::Invoice::CustomerTaxID::Country]
|
885
|
+
# @param type [Symbol, Orb::Invoice::CustomerTaxID::Type]
|
909
886
|
# @param value [String]
|
910
887
|
|
911
|
-
# @see Orb::
|
888
|
+
# @see Orb::Invoice::CustomerTaxID#country
|
912
889
|
module Country
|
913
890
|
extend Orb::Internal::Type::Enum
|
914
891
|
|
@@ -995,7 +972,7 @@ module Orb
|
|
995
972
|
# @return [Array<Symbol>]
|
996
973
|
end
|
997
974
|
|
998
|
-
# @see Orb::
|
975
|
+
# @see Orb::Invoice::CustomerTaxID#type
|
999
976
|
module Type
|
1000
977
|
extend Orb::Internal::Type::Enum
|
1001
978
|
|
@@ -1076,7 +1053,7 @@ module Orb
|
|
1076
1053
|
end
|
1077
1054
|
end
|
1078
1055
|
|
1079
|
-
# @see Orb::
|
1056
|
+
# @see Orb::Invoice#invoice_source
|
1080
1057
|
module InvoiceSource
|
1081
1058
|
extend Orb::Internal::Type::Enum
|
1082
1059
|
|
@@ -1107,9 +1084,8 @@ module Orb
|
|
1107
1084
|
# invoice calculations (ie. usage discounts -> amount discounts -> percentage
|
1108
1085
|
# discounts -> minimums -> maximums).
|
1109
1086
|
#
|
1110
|
-
# @return [Array<Orb::
|
1111
|
-
required :adjustments,
|
1112
|
-
-> { Orb::Internal::Type::ArrayOf[union: Orb::Models::Invoice::LineItem::Adjustment] }
|
1087
|
+
# @return [Array<Orb::Invoice::LineItem::Adjustment::UsageDiscount, Orb::Invoice::LineItem::Adjustment::AmountDiscount, Orb::Invoice::LineItem::Adjustment::PercentageDiscount, Orb::Invoice::LineItem::Adjustment::Minimum, Orb::Invoice::LineItem::Adjustment::Maximum>]
|
1088
|
+
required :adjustments, -> { Orb::Internal::Type::ArrayOf[union: Orb::Invoice::LineItem::Adjustment] }
|
1113
1089
|
|
1114
1090
|
# @!attribute amount
|
1115
1091
|
# The final amount for a line item after all adjustments and pre paid credits have
|
@@ -1126,8 +1102,8 @@ module Orb
|
|
1126
1102
|
|
1127
1103
|
# @!attribute discount
|
1128
1104
|
#
|
1129
|
-
# @return [Orb::
|
1130
|
-
required :discount, union: -> { Orb::
|
1105
|
+
# @return [Orb::PercentageDiscount, Orb::TrialDiscount, Orb::UsageDiscount, Orb::AmountDiscount, nil]
|
1106
|
+
required :discount, union: -> { Orb::Discount }, nil?: true
|
1131
1107
|
|
1132
1108
|
# @!attribute end_date
|
1133
1109
|
# The end date of the range of time applied for this line item's price.
|
@@ -1154,8 +1130,8 @@ module Orb
|
|
1154
1130
|
#
|
1155
1131
|
# This field is deprecated in favor of `adjustments`.
|
1156
1132
|
#
|
1157
|
-
# @return [Orb::
|
1158
|
-
required :maximum, -> { Orb::
|
1133
|
+
# @return [Orb::Invoice::LineItem::Maximum, nil]
|
1134
|
+
required :maximum, -> { Orb::Invoice::LineItem::Maximum }, nil?: true
|
1159
1135
|
|
1160
1136
|
# @!attribute maximum_amount
|
1161
1137
|
# @deprecated
|
@@ -1170,8 +1146,8 @@ module Orb
|
|
1170
1146
|
#
|
1171
1147
|
# This field is deprecated in favor of `adjustments`.
|
1172
1148
|
#
|
1173
|
-
# @return [Orb::
|
1174
|
-
required :minimum, -> { Orb::
|
1149
|
+
# @return [Orb::Invoice::LineItem::Minimum, nil]
|
1150
|
+
required :minimum, -> { Orb::Invoice::LineItem::Minimum }, nil?: true
|
1175
1151
|
|
1176
1152
|
# @!attribute minimum_amount
|
1177
1153
|
# @deprecated
|
@@ -1205,8 +1181,8 @@ module Orb
|
|
1205
1181
|
# For more on the types of prices, see
|
1206
1182
|
# [the core concepts documentation](/core-concepts#plan-and-price)
|
1207
1183
|
#
|
1208
|
-
# @return [Orb::
|
1209
|
-
required :price, union: -> { Orb::
|
1184
|
+
# @return [Orb::Price::Unit, Orb::Price::Package, Orb::Price::Matrix, Orb::Price::Tiered, Orb::Price::TieredBps, Orb::Price::Bps, Orb::Price::BulkBps, Orb::Price::Bulk, Orb::Price::ThresholdTotalAmount, Orb::Price::TieredPackage, Orb::Price::GroupedTiered, Orb::Price::TieredWithMinimum, Orb::Price::TieredPackageWithMinimum, Orb::Price::PackageWithAllocation, Orb::Price::UnitWithPercent, Orb::Price::MatrixWithAllocation, Orb::Price::TieredWithProration, Orb::Price::UnitWithProration, Orb::Price::GroupedAllocation, Orb::Price::GroupedWithProratedMinimum, Orb::Price::GroupedWithMeteredMinimum, Orb::Price::MatrixWithDisplayName, Orb::Price::BulkWithProration, Orb::Price::GroupedTieredPackage, Orb::Price::MaxGroupTieredPackage, Orb::Price::ScalableMatrixWithUnitPricing, Orb::Price::ScalableMatrixWithTieredPricing, Orb::Price::CumulativeGroupedBulk, nil]
|
1185
|
+
required :price, union: -> { Orb::Price }, nil?: true
|
1210
1186
|
|
1211
1187
|
# @!attribute quantity
|
1212
1188
|
# Either the fixed fee quantity or the usage during the service period.
|
@@ -1224,9 +1200,11 @@ module Orb
|
|
1224
1200
|
# For complex pricing structures, the line item can be broken down further in
|
1225
1201
|
# `sub_line_items`.
|
1226
1202
|
#
|
1227
|
-
# @return [Array<Orb::
|
1203
|
+
# @return [Array<Orb::Invoice::LineItem::SubLineItem::Matrix, Orb::Invoice::LineItem::SubLineItem::Tier, Orb::Invoice::LineItem::SubLineItem::Null>]
|
1228
1204
|
required :sub_line_items,
|
1229
|
-
-> {
|
1205
|
+
-> {
|
1206
|
+
Orb::Internal::Type::ArrayOf[union: Orb::Invoice::LineItem::SubLineItem]
|
1207
|
+
}
|
1230
1208
|
|
1231
1209
|
# @!attribute subtotal
|
1232
1210
|
# The line amount before before any adjustments.
|
@@ -1238,8 +1216,8 @@ module Orb
|
|
1238
1216
|
# An array of tax rates and their incurred tax amounts. Empty if no tax
|
1239
1217
|
# integration is configured.
|
1240
1218
|
#
|
1241
|
-
# @return [Array<Orb::
|
1242
|
-
required :tax_amounts, -> { Orb::Internal::Type::ArrayOf[Orb::
|
1219
|
+
# @return [Array<Orb::Invoice::LineItem::TaxAmount>]
|
1220
|
+
required :tax_amounts, -> { Orb::Internal::Type::ArrayOf[Orb::Invoice::LineItem::TaxAmount] }
|
1243
1221
|
|
1244
1222
|
# @!attribute usage_customer_ids
|
1245
1223
|
# A list of customer ids that were used to calculate the usage for this line item.
|
@@ -1248,36 +1226,32 @@ module Orb
|
|
1248
1226
|
required :usage_customer_ids, Orb::Internal::Type::ArrayOf[String], nil?: true
|
1249
1227
|
|
1250
1228
|
# @!method initialize(id:, adjusted_subtotal:, adjustments:, amount:, credits_applied:, discount:, end_date:, filter:, grouping:, maximum:, maximum_amount:, minimum:, minimum_amount:, name:, partially_invoiced_amount:, price:, quantity:, start_date:, sub_line_items:, subtotal:, tax_amounts:, usage_customer_ids:)
|
1251
|
-
# Some parameter documentations has been truncated, see
|
1252
|
-
#
|
1229
|
+
# Some parameter documentations has been truncated, see {Orb::Invoice::LineItem}
|
1230
|
+
# for more details.
|
1253
1231
|
#
|
1254
1232
|
# @param id [String] A unique ID for this line item.
|
1255
1233
|
#
|
1256
1234
|
# @param adjusted_subtotal [String] The line amount after any adjustments and before overage conversion, credits and
|
1257
|
-
# ...
|
1258
1235
|
#
|
1259
|
-
# @param adjustments [Array<Orb::
|
1260
|
-
# ...
|
1236
|
+
# @param adjustments [Array<Orb::Invoice::LineItem::Adjustment::UsageDiscount, Orb::Invoice::LineItem::Adjustment::AmountDiscount, Orb::Invoice::LineItem::Adjustment::PercentageDiscount, Orb::Invoice::LineItem::Adjustment::Minimum, Orb::Invoice::LineItem::Adjustment::Maximum>] All adjustments applied to the line item in the order they were applied based on
|
1261
1237
|
#
|
1262
1238
|
# @param amount [String] The final amount for a line item after all adjustments and pre paid credits have
|
1263
|
-
# ...
|
1264
1239
|
#
|
1265
1240
|
# @param credits_applied [String] The number of prepaid credits applied.
|
1266
1241
|
#
|
1267
|
-
# @param discount [Orb::
|
1242
|
+
# @param discount [Orb::PercentageDiscount, Orb::TrialDiscount, Orb::UsageDiscount, Orb::AmountDiscount, nil]
|
1268
1243
|
#
|
1269
1244
|
# @param end_date [Time] The end date of the range of time applied for this line item's price.
|
1270
1245
|
#
|
1271
1246
|
# @param filter [String, nil] An additional filter that was used to calculate the usage for this line item.
|
1272
1247
|
#
|
1273
1248
|
# @param grouping [String, nil] [DEPRECATED] For configured prices that are split by a grouping key, this will b
|
1274
|
-
# ...
|
1275
1249
|
#
|
1276
|
-
# @param maximum [Orb::
|
1250
|
+
# @param maximum [Orb::Invoice::LineItem::Maximum, nil] This field is deprecated in favor of `adjustments`.
|
1277
1251
|
#
|
1278
1252
|
# @param maximum_amount [String, nil] This field is deprecated in favor of `adjustments`.
|
1279
1253
|
#
|
1280
|
-
# @param minimum [Orb::
|
1254
|
+
# @param minimum [Orb::Invoice::LineItem::Minimum, nil] This field is deprecated in favor of `adjustments`.
|
1281
1255
|
#
|
1282
1256
|
# @param minimum_amount [String, nil] This field is deprecated in favor of `adjustments`.
|
1283
1257
|
#
|
@@ -1285,43 +1259,36 @@ module Orb
|
|
1285
1259
|
#
|
1286
1260
|
# @param partially_invoiced_amount [String] Any amount applied from a partial invoice
|
1287
1261
|
#
|
1288
|
-
# @param price [Orb::
|
1289
|
-
# ...
|
1262
|
+
# @param price [Orb::Price::Unit, Orb::Price::Package, Orb::Price::Matrix, Orb::Price::Tiered, Orb::Price::TieredBps, Orb::Price::Bps, Orb::Price::BulkBps, Orb::Price::Bulk, Orb::Price::ThresholdTotalAmount, Orb::Price::TieredPackage, Orb::Price::GroupedTiered, Orb::Price::TieredWithMinimum, Orb::Price::TieredPackageWithMinimum, Orb::Price::PackageWithAllocation, Orb::Price::UnitWithPercent, Orb::Price::MatrixWithAllocation, Orb::Price::TieredWithProration, Orb::Price::UnitWithProration, Orb::Price::GroupedAllocation, Orb::Price::GroupedWithProratedMinimum, Orb::Price::GroupedWithMeteredMinimum, Orb::Price::MatrixWithDisplayName, Orb::Price::BulkWithProration, Orb::Price::GroupedTieredPackage, Orb::Price::MaxGroupTieredPackage, Orb::Price::ScalableMatrixWithUnitPricing, Orb::Price::ScalableMatrixWithTieredPricing, Orb::Price::CumulativeGroupedBulk, nil] The Price resource represents a price that can be billed on a subscription, resu
|
1290
1263
|
#
|
1291
1264
|
# @param quantity [Float] Either the fixed fee quantity or the usage during the service period.
|
1292
1265
|
#
|
1293
1266
|
# @param start_date [Time] The start date of the range of time applied for this line item's price.
|
1294
1267
|
#
|
1295
|
-
# @param sub_line_items [Array<Orb::
|
1296
|
-
# ...
|
1268
|
+
# @param sub_line_items [Array<Orb::Invoice::LineItem::SubLineItem::Matrix, Orb::Invoice::LineItem::SubLineItem::Tier, Orb::Invoice::LineItem::SubLineItem::Null>] For complex pricing structures, the line item can be broken down further in `sub
|
1297
1269
|
#
|
1298
1270
|
# @param subtotal [String] The line amount before before any adjustments.
|
1299
1271
|
#
|
1300
|
-
# @param tax_amounts [Array<Orb::
|
1301
|
-
# ...
|
1272
|
+
# @param tax_amounts [Array<Orb::Invoice::LineItem::TaxAmount>] An array of tax rates and their incurred tax amounts. Empty if no tax integratio
|
1302
1273
|
#
|
1303
1274
|
# @param usage_customer_ids [Array<String>, nil] A list of customer ids that were used to calculate the usage for this line item.
|
1304
|
-
# ...
|
1305
1275
|
|
1306
1276
|
module Adjustment
|
1307
1277
|
extend Orb::Internal::Type::Union
|
1308
1278
|
|
1309
1279
|
discriminator :adjustment_type
|
1310
1280
|
|
1311
|
-
variant :usage_discount,
|
1312
|
-
-> { Orb::Models::Invoice::LineItem::Adjustment::MonetaryUsageDiscountAdjustment }
|
1281
|
+
variant :usage_discount, -> { Orb::Invoice::LineItem::Adjustment::UsageDiscount }
|
1313
1282
|
|
1314
|
-
variant :amount_discount,
|
1315
|
-
-> { Orb::Models::Invoice::LineItem::Adjustment::MonetaryAmountDiscountAdjustment }
|
1283
|
+
variant :amount_discount, -> { Orb::Invoice::LineItem::Adjustment::AmountDiscount }
|
1316
1284
|
|
1317
|
-
variant :percentage_discount,
|
1318
|
-
-> { Orb::Models::Invoice::LineItem::Adjustment::MonetaryPercentageDiscountAdjustment }
|
1285
|
+
variant :percentage_discount, -> { Orb::Invoice::LineItem::Adjustment::PercentageDiscount }
|
1319
1286
|
|
1320
|
-
variant :minimum, -> { Orb::
|
1287
|
+
variant :minimum, -> { Orb::Invoice::LineItem::Adjustment::Minimum }
|
1321
1288
|
|
1322
|
-
variant :maximum, -> { Orb::
|
1289
|
+
variant :maximum, -> { Orb::Invoice::LineItem::Adjustment::Maximum }
|
1323
1290
|
|
1324
|
-
class
|
1291
|
+
class UsageDiscount < Orb::Internal::Type::BaseModel
|
1325
1292
|
# @!attribute id
|
1326
1293
|
#
|
1327
1294
|
# @return [String]
|
@@ -1366,8 +1333,7 @@ module Orb
|
|
1366
1333
|
|
1367
1334
|
# @!method initialize(id:, amount:, applies_to_price_ids:, is_invoice_level:, reason:, usage_discount:, adjustment_type: :usage_discount)
|
1368
1335
|
# Some parameter documentations has been truncated, see
|
1369
|
-
# {Orb::
|
1370
|
-
# for more details.
|
1336
|
+
# {Orb::Invoice::LineItem::Adjustment::UsageDiscount} for more details.
|
1371
1337
|
#
|
1372
1338
|
# @param id [String]
|
1373
1339
|
#
|
@@ -1376,17 +1342,15 @@ module Orb
|
|
1376
1342
|
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
1377
1343
|
#
|
1378
1344
|
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
1379
|
-
# ...
|
1380
1345
|
#
|
1381
1346
|
# @param reason [String, nil] The reason for the adjustment.
|
1382
1347
|
#
|
1383
1348
|
# @param usage_discount [Float] The number of usage units by which to discount the price this adjustment applies
|
1384
|
-
# ...
|
1385
1349
|
#
|
1386
1350
|
# @param adjustment_type [Symbol, :usage_discount]
|
1387
1351
|
end
|
1388
1352
|
|
1389
|
-
class
|
1353
|
+
class AmountDiscount < Orb::Internal::Type::BaseModel
|
1390
1354
|
# @!attribute id
|
1391
1355
|
#
|
1392
1356
|
# @return [String]
|
@@ -1431,27 +1395,24 @@ module Orb
|
|
1431
1395
|
|
1432
1396
|
# @!method initialize(id:, amount:, amount_discount:, applies_to_price_ids:, is_invoice_level:, reason:, adjustment_type: :amount_discount)
|
1433
1397
|
# Some parameter documentations has been truncated, see
|
1434
|
-
# {Orb::
|
1435
|
-
# for more details.
|
1398
|
+
# {Orb::Invoice::LineItem::Adjustment::AmountDiscount} for more details.
|
1436
1399
|
#
|
1437
1400
|
# @param id [String]
|
1438
1401
|
#
|
1439
1402
|
# @param amount [String] The value applied by an adjustment.
|
1440
1403
|
#
|
1441
1404
|
# @param amount_discount [String] The amount by which to discount the prices this adjustment applies to in a given
|
1442
|
-
# ...
|
1443
1405
|
#
|
1444
1406
|
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
1445
1407
|
#
|
1446
1408
|
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
1447
|
-
# ...
|
1448
1409
|
#
|
1449
1410
|
# @param reason [String, nil] The reason for the adjustment.
|
1450
1411
|
#
|
1451
1412
|
# @param adjustment_type [Symbol, :amount_discount]
|
1452
1413
|
end
|
1453
1414
|
|
1454
|
-
class
|
1415
|
+
class PercentageDiscount < Orb::Internal::Type::BaseModel
|
1455
1416
|
# @!attribute id
|
1456
1417
|
#
|
1457
1418
|
# @return [String]
|
@@ -1496,8 +1457,7 @@ module Orb
|
|
1496
1457
|
|
1497
1458
|
# @!method initialize(id:, amount:, applies_to_price_ids:, is_invoice_level:, percentage_discount:, reason:, adjustment_type: :percentage_discount)
|
1498
1459
|
# Some parameter documentations has been truncated, see
|
1499
|
-
# {Orb::
|
1500
|
-
# for more details.
|
1460
|
+
# {Orb::Invoice::LineItem::Adjustment::PercentageDiscount} for more details.
|
1501
1461
|
#
|
1502
1462
|
# @param id [String]
|
1503
1463
|
#
|
@@ -1506,17 +1466,15 @@ module Orb
|
|
1506
1466
|
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
1507
1467
|
#
|
1508
1468
|
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
1509
|
-
# ...
|
1510
1469
|
#
|
1511
1470
|
# @param percentage_discount [Float] The percentage (as a value between 0 and 1) by which to discount the price inter
|
1512
|
-
# ...
|
1513
1471
|
#
|
1514
1472
|
# @param reason [String, nil] The reason for the adjustment.
|
1515
1473
|
#
|
1516
1474
|
# @param adjustment_type [Symbol, :percentage_discount]
|
1517
1475
|
end
|
1518
1476
|
|
1519
|
-
class
|
1477
|
+
class Minimum < Orb::Internal::Type::BaseModel
|
1520
1478
|
# @!attribute id
|
1521
1479
|
#
|
1522
1480
|
# @return [String]
|
@@ -1567,8 +1525,7 @@ module Orb
|
|
1567
1525
|
|
1568
1526
|
# @!method initialize(id:, amount:, applies_to_price_ids:, is_invoice_level:, item_id:, minimum_amount:, reason:, adjustment_type: :minimum)
|
1569
1527
|
# Some parameter documentations has been truncated, see
|
1570
|
-
# {Orb::
|
1571
|
-
# details.
|
1528
|
+
# {Orb::Invoice::LineItem::Adjustment::Minimum} for more details.
|
1572
1529
|
#
|
1573
1530
|
# @param id [String]
|
1574
1531
|
#
|
@@ -1577,19 +1534,17 @@ module Orb
|
|
1577
1534
|
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
1578
1535
|
#
|
1579
1536
|
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
1580
|
-
# ...
|
1581
1537
|
#
|
1582
1538
|
# @param item_id [String] The item ID that revenue from this minimum will be attributed to.
|
1583
1539
|
#
|
1584
1540
|
# @param minimum_amount [String] The minimum amount to charge in a given billing period for the prices this adjus
|
1585
|
-
# ...
|
1586
1541
|
#
|
1587
1542
|
# @param reason [String, nil] The reason for the adjustment.
|
1588
1543
|
#
|
1589
1544
|
# @param adjustment_type [Symbol, :minimum]
|
1590
1545
|
end
|
1591
1546
|
|
1592
|
-
class
|
1547
|
+
class Maximum < Orb::Internal::Type::BaseModel
|
1593
1548
|
# @!attribute id
|
1594
1549
|
#
|
1595
1550
|
# @return [String]
|
@@ -1634,8 +1589,7 @@ module Orb
|
|
1634
1589
|
|
1635
1590
|
# @!method initialize(id:, amount:, applies_to_price_ids:, is_invoice_level:, maximum_amount:, reason:, adjustment_type: :maximum)
|
1636
1591
|
# Some parameter documentations has been truncated, see
|
1637
|
-
# {Orb::
|
1638
|
-
# details.
|
1592
|
+
# {Orb::Invoice::LineItem::Adjustment::Maximum} for more details.
|
1639
1593
|
#
|
1640
1594
|
# @param id [String]
|
1641
1595
|
#
|
@@ -1644,10 +1598,8 @@ module Orb
|
|
1644
1598
|
# @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
|
1645
1599
|
#
|
1646
1600
|
# @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
|
1647
|
-
# ...
|
1648
1601
|
#
|
1649
1602
|
# @param maximum_amount [String] The maximum amount to charge in a given billing period for the prices this adjus
|
1650
|
-
# ...
|
1651
1603
|
#
|
1652
1604
|
# @param reason [String, nil] The reason for the adjustment.
|
1653
1605
|
#
|
@@ -1655,12 +1607,12 @@ module Orb
|
|
1655
1607
|
end
|
1656
1608
|
|
1657
1609
|
# @!method self.variants
|
1658
|
-
# @return [Array(Orb::
|
1610
|
+
# @return [Array(Orb::Invoice::LineItem::Adjustment::UsageDiscount, Orb::Invoice::LineItem::Adjustment::AmountDiscount, Orb::Invoice::LineItem::Adjustment::PercentageDiscount, Orb::Invoice::LineItem::Adjustment::Minimum, Orb::Invoice::LineItem::Adjustment::Maximum)]
|
1659
1611
|
end
|
1660
1612
|
|
1661
1613
|
# @deprecated
|
1662
1614
|
#
|
1663
|
-
# @see Orb::
|
1615
|
+
# @see Orb::Invoice::LineItem#maximum
|
1664
1616
|
class Maximum < Orb::Internal::Type::BaseModel
|
1665
1617
|
# @!attribute applies_to_price_ids
|
1666
1618
|
# List of price_ids that this maximum amount applies to. For plan/plan phase
|
@@ -1677,19 +1629,18 @@ module Orb
|
|
1677
1629
|
|
1678
1630
|
# @!method initialize(applies_to_price_ids:, maximum_amount:)
|
1679
1631
|
# Some parameter documentations has been truncated, see
|
1680
|
-
# {Orb::
|
1632
|
+
# {Orb::Invoice::LineItem::Maximum} for more details.
|
1681
1633
|
#
|
1682
1634
|
# This field is deprecated in favor of `adjustments`.
|
1683
1635
|
#
|
1684
1636
|
# @param applies_to_price_ids [Array<String>] List of price_ids that this maximum amount applies to. For plan/plan phase maxim
|
1685
|
-
# ...
|
1686
1637
|
#
|
1687
1638
|
# @param maximum_amount [String] Maximum amount applied
|
1688
1639
|
end
|
1689
1640
|
|
1690
1641
|
# @deprecated
|
1691
1642
|
#
|
1692
|
-
# @see Orb::
|
1643
|
+
# @see Orb::Invoice::LineItem#minimum
|
1693
1644
|
class Minimum < Orb::Internal::Type::BaseModel
|
1694
1645
|
# @!attribute applies_to_price_ids
|
1695
1646
|
# List of price_ids that this minimum amount applies to. For plan/plan phase
|
@@ -1706,12 +1657,11 @@ module Orb
|
|
1706
1657
|
|
1707
1658
|
# @!method initialize(applies_to_price_ids:, minimum_amount:)
|
1708
1659
|
# Some parameter documentations has been truncated, see
|
1709
|
-
# {Orb::
|
1660
|
+
# {Orb::Invoice::LineItem::Minimum} for more details.
|
1710
1661
|
#
|
1711
1662
|
# This field is deprecated in favor of `adjustments`.
|
1712
1663
|
#
|
1713
1664
|
# @param applies_to_price_ids [Array<String>] List of price_ids that this minimum amount applies to. For plan/plan phase minim
|
1714
|
-
# ...
|
1715
1665
|
#
|
1716
1666
|
# @param minimum_amount [String] Minimum amount applied
|
1717
1667
|
end
|
@@ -1721,13 +1671,13 @@ module Orb
|
|
1721
1671
|
|
1722
1672
|
discriminator :type
|
1723
1673
|
|
1724
|
-
variant :matrix, -> { Orb::
|
1674
|
+
variant :matrix, -> { Orb::Invoice::LineItem::SubLineItem::Matrix }
|
1725
1675
|
|
1726
|
-
variant :tier, -> { Orb::
|
1676
|
+
variant :tier, -> { Orb::Invoice::LineItem::SubLineItem::Tier }
|
1727
1677
|
|
1728
|
-
variant :"'null'", -> { Orb::
|
1678
|
+
variant :"'null'", -> { Orb::Invoice::LineItem::SubLineItem::Null }
|
1729
1679
|
|
1730
|
-
class
|
1680
|
+
class Matrix < Orb::Internal::Type::BaseModel
|
1731
1681
|
# @!attribute amount
|
1732
1682
|
# The total amount for this sub line item.
|
1733
1683
|
#
|
@@ -1736,16 +1686,13 @@ module Orb
|
|
1736
1686
|
|
1737
1687
|
# @!attribute grouping
|
1738
1688
|
#
|
1739
|
-
# @return [Orb::
|
1740
|
-
required :grouping,
|
1741
|
-
-> { Orb::Models::Invoice::LineItem::SubLineItem::MatrixSubLineItem::Grouping },
|
1742
|
-
nil?: true
|
1689
|
+
# @return [Orb::Invoice::LineItem::SubLineItem::Matrix::Grouping, nil]
|
1690
|
+
required :grouping, -> { Orb::Invoice::LineItem::SubLineItem::Matrix::Grouping }, nil?: true
|
1743
1691
|
|
1744
1692
|
# @!attribute matrix_config
|
1745
1693
|
#
|
1746
|
-
# @return [Orb::
|
1747
|
-
required :matrix_config,
|
1748
|
-
-> { Orb::Models::Invoice::LineItem::SubLineItem::MatrixSubLineItem::MatrixConfig }
|
1694
|
+
# @return [Orb::Invoice::LineItem::SubLineItem::Matrix::MatrixConfig]
|
1695
|
+
required :matrix_config, -> { Orb::Invoice::LineItem::SubLineItem::Matrix::MatrixConfig }
|
1749
1696
|
|
1750
1697
|
# @!attribute name
|
1751
1698
|
#
|
@@ -1765,9 +1712,9 @@ module Orb
|
|
1765
1712
|
# @!method initialize(amount:, grouping:, matrix_config:, name:, quantity:, type: :matrix)
|
1766
1713
|
# @param amount [String] The total amount for this sub line item.
|
1767
1714
|
#
|
1768
|
-
# @param grouping [Orb::
|
1715
|
+
# @param grouping [Orb::Invoice::LineItem::SubLineItem::Matrix::Grouping, nil]
|
1769
1716
|
#
|
1770
|
-
# @param matrix_config [Orb::
|
1717
|
+
# @param matrix_config [Orb::Invoice::LineItem::SubLineItem::Matrix::MatrixConfig]
|
1771
1718
|
#
|
1772
1719
|
# @param name [String]
|
1773
1720
|
#
|
@@ -1775,7 +1722,7 @@ module Orb
|
|
1775
1722
|
#
|
1776
1723
|
# @param type [Symbol, :matrix]
|
1777
1724
|
|
1778
|
-
# @see Orb::
|
1725
|
+
# @see Orb::Invoice::LineItem::SubLineItem::Matrix#grouping
|
1779
1726
|
class Grouping < Orb::Internal::Type::BaseModel
|
1780
1727
|
# @!attribute key
|
1781
1728
|
#
|
@@ -1794,7 +1741,7 @@ module Orb
|
|
1794
1741
|
# @param value [String, nil] No value indicates the default group
|
1795
1742
|
end
|
1796
1743
|
|
1797
|
-
# @see Orb::
|
1744
|
+
# @see Orb::Invoice::LineItem::SubLineItem::Matrix#matrix_config
|
1798
1745
|
class MatrixConfig < Orb::Internal::Type::BaseModel
|
1799
1746
|
# @!attribute dimension_values
|
1800
1747
|
# The ordered dimension values for this line item.
|
@@ -1807,7 +1754,7 @@ module Orb
|
|
1807
1754
|
end
|
1808
1755
|
end
|
1809
1756
|
|
1810
|
-
class
|
1757
|
+
class Tier < Orb::Internal::Type::BaseModel
|
1811
1758
|
# @!attribute amount
|
1812
1759
|
# The total amount for this sub line item.
|
1813
1760
|
#
|
@@ -1816,10 +1763,8 @@ module Orb
|
|
1816
1763
|
|
1817
1764
|
# @!attribute grouping
|
1818
1765
|
#
|
1819
|
-
# @return [Orb::
|
1820
|
-
required :grouping,
|
1821
|
-
-> { Orb::Models::Invoice::LineItem::SubLineItem::TierSubLineItem::Grouping },
|
1822
|
-
nil?: true
|
1766
|
+
# @return [Orb::Invoice::LineItem::SubLineItem::Tier::Grouping, nil]
|
1767
|
+
required :grouping, -> { Orb::Invoice::LineItem::SubLineItem::Tier::Grouping }, nil?: true
|
1823
1768
|
|
1824
1769
|
# @!attribute name
|
1825
1770
|
#
|
@@ -1833,8 +1778,8 @@ module Orb
|
|
1833
1778
|
|
1834
1779
|
# @!attribute tier_config
|
1835
1780
|
#
|
1836
|
-
# @return [Orb::
|
1837
|
-
required :tier_config, -> { Orb::
|
1781
|
+
# @return [Orb::Invoice::LineItem::SubLineItem::Tier::TierConfig]
|
1782
|
+
required :tier_config, -> { Orb::Invoice::LineItem::SubLineItem::Tier::TierConfig }
|
1838
1783
|
|
1839
1784
|
# @!attribute type
|
1840
1785
|
#
|
@@ -1844,17 +1789,17 @@ module Orb
|
|
1844
1789
|
# @!method initialize(amount:, grouping:, name:, quantity:, tier_config:, type: :tier)
|
1845
1790
|
# @param amount [String] The total amount for this sub line item.
|
1846
1791
|
#
|
1847
|
-
# @param grouping [Orb::
|
1792
|
+
# @param grouping [Orb::Invoice::LineItem::SubLineItem::Tier::Grouping, nil]
|
1848
1793
|
#
|
1849
1794
|
# @param name [String]
|
1850
1795
|
#
|
1851
1796
|
# @param quantity [Float]
|
1852
1797
|
#
|
1853
|
-
# @param tier_config [Orb::
|
1798
|
+
# @param tier_config [Orb::Invoice::LineItem::SubLineItem::Tier::TierConfig]
|
1854
1799
|
#
|
1855
1800
|
# @param type [Symbol, :tier]
|
1856
1801
|
|
1857
|
-
# @see Orb::
|
1802
|
+
# @see Orb::Invoice::LineItem::SubLineItem::Tier#grouping
|
1858
1803
|
class Grouping < Orb::Internal::Type::BaseModel
|
1859
1804
|
# @!attribute key
|
1860
1805
|
#
|
@@ -1873,7 +1818,7 @@ module Orb
|
|
1873
1818
|
# @param value [String, nil] No value indicates the default group
|
1874
1819
|
end
|
1875
1820
|
|
1876
|
-
# @see Orb::
|
1821
|
+
# @see Orb::Invoice::LineItem::SubLineItem::Tier#tier_config
|
1877
1822
|
class TierConfig < Orb::Internal::Type::BaseModel
|
1878
1823
|
# @!attribute first_unit
|
1879
1824
|
#
|
@@ -1897,7 +1842,7 @@ module Orb
|
|
1897
1842
|
end
|
1898
1843
|
end
|
1899
1844
|
|
1900
|
-
class
|
1845
|
+
class Null < Orb::Internal::Type::BaseModel
|
1901
1846
|
# @!attribute amount
|
1902
1847
|
# The total amount for this sub line item.
|
1903
1848
|
#
|
@@ -1906,10 +1851,8 @@ module Orb
|
|
1906
1851
|
|
1907
1852
|
# @!attribute grouping
|
1908
1853
|
#
|
1909
|
-
# @return [Orb::
|
1910
|
-
required :grouping,
|
1911
|
-
-> { Orb::Models::Invoice::LineItem::SubLineItem::OtherSubLineItem::Grouping },
|
1912
|
-
nil?: true
|
1854
|
+
# @return [Orb::Invoice::LineItem::SubLineItem::Null::Grouping, nil]
|
1855
|
+
required :grouping, -> { Orb::Invoice::LineItem::SubLineItem::Null::Grouping }, nil?: true
|
1913
1856
|
|
1914
1857
|
# @!attribute name
|
1915
1858
|
#
|
@@ -1929,7 +1872,7 @@ module Orb
|
|
1929
1872
|
# @!method initialize(amount:, grouping:, name:, quantity:, type: :"'null'")
|
1930
1873
|
# @param amount [String] The total amount for this sub line item.
|
1931
1874
|
#
|
1932
|
-
# @param grouping [Orb::
|
1875
|
+
# @param grouping [Orb::Invoice::LineItem::SubLineItem::Null::Grouping, nil]
|
1933
1876
|
#
|
1934
1877
|
# @param name [String]
|
1935
1878
|
#
|
@@ -1937,7 +1880,7 @@ module Orb
|
|
1937
1880
|
#
|
1938
1881
|
# @param type [Symbol, :"'null'"]
|
1939
1882
|
|
1940
|
-
# @see Orb::
|
1883
|
+
# @see Orb::Invoice::LineItem::SubLineItem::Null#grouping
|
1941
1884
|
class Grouping < Orb::Internal::Type::BaseModel
|
1942
1885
|
# @!attribute key
|
1943
1886
|
#
|
@@ -1958,7 +1901,7 @@ module Orb
|
|
1958
1901
|
end
|
1959
1902
|
|
1960
1903
|
# @!method self.variants
|
1961
|
-
# @return [Array(Orb::
|
1904
|
+
# @return [Array(Orb::Invoice::LineItem::SubLineItem::Matrix, Orb::Invoice::LineItem::SubLineItem::Tier, Orb::Invoice::LineItem::SubLineItem::Null)]
|
1962
1905
|
end
|
1963
1906
|
|
1964
1907
|
class TaxAmount < Orb::Internal::Type::BaseModel
|
@@ -1989,7 +1932,7 @@ module Orb
|
|
1989
1932
|
end
|
1990
1933
|
end
|
1991
1934
|
|
1992
|
-
# @see Orb::
|
1935
|
+
# @see Orb::Invoice#maximum
|
1993
1936
|
class Maximum < Orb::Internal::Type::BaseModel
|
1994
1937
|
# @!attribute applies_to_price_ids
|
1995
1938
|
# List of price_ids that this maximum amount applies to. For plan/plan phase
|
@@ -2005,16 +1948,15 @@ module Orb
|
|
2005
1948
|
required :maximum_amount, String
|
2006
1949
|
|
2007
1950
|
# @!method initialize(applies_to_price_ids:, maximum_amount:)
|
2008
|
-
# Some parameter documentations has been truncated, see
|
2009
|
-
#
|
1951
|
+
# Some parameter documentations has been truncated, see {Orb::Invoice::Maximum}
|
1952
|
+
# for more details.
|
2010
1953
|
#
|
2011
1954
|
# @param applies_to_price_ids [Array<String>] List of price_ids that this maximum amount applies to. For plan/plan phase maxim
|
2012
|
-
# ...
|
2013
1955
|
#
|
2014
1956
|
# @param maximum_amount [String] Maximum amount applied
|
2015
1957
|
end
|
2016
1958
|
|
2017
|
-
# @see Orb::
|
1959
|
+
# @see Orb::Invoice#minimum
|
2018
1960
|
class Minimum < Orb::Internal::Type::BaseModel
|
2019
1961
|
# @!attribute applies_to_price_ids
|
2020
1962
|
# List of price_ids that this minimum amount applies to. For plan/plan phase
|
@@ -2030,11 +1972,10 @@ module Orb
|
|
2030
1972
|
required :minimum_amount, String
|
2031
1973
|
|
2032
1974
|
# @!method initialize(applies_to_price_ids:, minimum_amount:)
|
2033
|
-
# Some parameter documentations has been truncated, see
|
2034
|
-
#
|
1975
|
+
# Some parameter documentations has been truncated, see {Orb::Invoice::Minimum}
|
1976
|
+
# for more details.
|
2035
1977
|
#
|
2036
1978
|
# @param applies_to_price_ids [Array<String>] List of price_ids that this minimum amount applies to. For plan/plan phase minim
|
2037
|
-
# ...
|
2038
1979
|
#
|
2039
1980
|
# @param minimum_amount [String] Minimum amount applied
|
2040
1981
|
end
|
@@ -2061,8 +2002,8 @@ module Orb
|
|
2061
2002
|
# @!attribute payment_provider
|
2062
2003
|
# The payment provider that attempted to collect the payment.
|
2063
2004
|
#
|
2064
|
-
# @return [Symbol, Orb::
|
2065
|
-
required :payment_provider, enum: -> { Orb::
|
2005
|
+
# @return [Symbol, Orb::Invoice::PaymentAttempt::PaymentProvider, nil]
|
2006
|
+
required :payment_provider, enum: -> { Orb::Invoice::PaymentAttempt::PaymentProvider }, nil?: true
|
2066
2007
|
|
2067
2008
|
# @!attribute payment_provider_id
|
2068
2009
|
# The ID of the payment attempt in the payment provider.
|
@@ -2083,7 +2024,7 @@ module Orb
|
|
2083
2024
|
#
|
2084
2025
|
# @param created_at [Time] The time at which the payment attempt was created.
|
2085
2026
|
#
|
2086
|
-
# @param payment_provider [Symbol, Orb::
|
2027
|
+
# @param payment_provider [Symbol, Orb::Invoice::PaymentAttempt::PaymentProvider, nil] The payment provider that attempted to collect the payment.
|
2087
2028
|
#
|
2088
2029
|
# @param payment_provider_id [String, nil] The ID of the payment attempt in the payment provider.
|
2089
2030
|
#
|
@@ -2091,7 +2032,7 @@ module Orb
|
|
2091
2032
|
|
2092
2033
|
# The payment provider that attempted to collect the payment.
|
2093
2034
|
#
|
2094
|
-
# @see Orb::
|
2035
|
+
# @see Orb::Invoice::PaymentAttempt#payment_provider
|
2095
2036
|
module PaymentProvider
|
2096
2037
|
extend Orb::Internal::Type::Enum
|
2097
2038
|
|
@@ -2102,7 +2043,7 @@ module Orb
|
|
2102
2043
|
end
|
2103
2044
|
end
|
2104
2045
|
|
2105
|
-
# @see Orb::
|
2046
|
+
# @see Orb::Invoice#shipping_address
|
2106
2047
|
class ShippingAddress < Orb::Internal::Type::BaseModel
|
2107
2048
|
# @!attribute city
|
2108
2049
|
#
|
@@ -2143,7 +2084,7 @@ module Orb
|
|
2143
2084
|
# @param state [String, nil]
|
2144
2085
|
end
|
2145
2086
|
|
2146
|
-
# @see Orb::
|
2087
|
+
# @see Orb::Invoice#status
|
2147
2088
|
module Status
|
2148
2089
|
extend Orb::Internal::Type::Enum
|
2149
2090
|
|
@@ -2157,7 +2098,7 @@ module Orb
|
|
2157
2098
|
# @return [Array<Symbol>]
|
2158
2099
|
end
|
2159
2100
|
|
2160
|
-
# @see Orb::
|
2101
|
+
# @see Orb::Invoice#subscription
|
2161
2102
|
class Subscription < Orb::Internal::Type::BaseModel
|
2162
2103
|
# @!attribute id
|
2163
2104
|
#
|