orb-billing 0.3.0 → 0.3.1
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 +33 -0
- data/README.md +5 -5
- data/lib/orb/errors.rb +9 -9
- 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 +10 -11
- data/lib/orb/internal/type/request_parameters.rb +2 -8
- data/lib/orb/internal/type/unknown.rb +10 -11
- data/lib/orb/internal/util.rb +20 -4
- data/lib/orb/models/coupon_create_params.rb +7 -7
- data/lib/orb/models/customer_create_params.rb +7 -7
- data/lib/orb/models/customer_update_by_external_id_params.rb +7 -9
- data/lib/orb/models/customer_update_params.rb +7 -7
- data/lib/orb/models/customers/cost_list_by_external_id_response.rb +2 -2
- data/lib/orb/models/customers/cost_list_response.rb +2 -2
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +106 -107
- data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +111 -119
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +110 -114
- data/lib/orb/models/customers/credits/ledger_list_response.rb +112 -124
- data/lib/orb/models/invoice.rb +50 -64
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +51 -55
- data/lib/orb/models/invoice_line_item_create_response.rb +54 -57
- data/lib/orb/models/plan.rb +20 -23
- data/lib/orb/models/plan_create_params.rb +635 -670
- data/lib/orb/models/price.rb +1547 -1599
- data/lib/orb/models/subscription.rb +35 -41
- data/lib/orb/models/subscription_cancel_response.rb +33 -36
- data/lib/orb/models/subscription_change_apply_response.rb +31 -32
- data/lib/orb/models/subscription_change_cancel_response.rb +31 -31
- data/lib/orb/models/subscription_change_retrieve_response.rb +31 -31
- data/lib/orb/models/subscription_create_params.rb +1316 -1367
- data/lib/orb/models/subscription_create_response.rb +33 -36
- data/lib/orb/models/subscription_fetch_costs_response.rb +2 -2
- data/lib/orb/models/subscription_price_intervals_params.rb +748 -774
- data/lib/orb/models/subscription_price_intervals_response.rb +32 -35
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +1299 -1354
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +31 -33
- data/lib/orb/models/subscription_trigger_phase_response.rb +32 -35
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +31 -33
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +31 -31
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +31 -31
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +31 -33
- data/lib/orb/models/subscription_update_trial_response.rb +33 -36
- data/lib/orb/models.rb +220 -0
- data/lib/orb/request_options.rb +4 -5
- data/lib/orb/resources/coupons.rb +1 -1
- data/lib/orb/resources/customers/credits/ledger.rb +4 -4
- data/lib/orb/resources/customers.rb +3 -3
- data/lib/orb/resources/plans.rb +1 -1
- data/lib/orb/resources/prices/external_price_id.rb +2 -2
- data/lib/orb/resources/prices.rb +4 -4
- data/lib/orb/version.rb +1 -1
- data/rbi/{lib/orb → orb}/errors.rbi +1 -1
- data/rbi/{lib/orb → orb}/internal/transport/base_client.rbi +2 -2
- data/rbi/{lib/orb → orb}/internal/type/request_parameters.rbi +1 -1
- data/rbi/{lib/orb → orb}/internal/util.rbi +5 -1
- data/rbi/{lib/orb → orb}/models/coupon_create_params.rbi +9 -9
- data/rbi/{lib/orb → orb}/models/customer_create_params.rbi +9 -9
- data/rbi/{lib/orb → orb}/models/customer_update_by_external_id_params.rbi +9 -9
- data/rbi/{lib/orb → orb}/models/customer_update_params.rbi +9 -9
- data/rbi/{lib/orb → orb}/models/customers/cost_list_by_external_id_response.rbi +84 -84
- data/rbi/{lib/orb → orb}/models/customers/cost_list_response.rbi +84 -84
- data/rbi/{lib/orb/models/customers/credits/ledger_create_entry_response.rbi → orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi} +122 -114
- data/rbi/{lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi → orb/models/customers/credits/ledger_create_entry_response.rbi} +114 -216
- data/rbi/{lib/orb/models/customers/credits/ledger_list_response.rbi → orb/models/customers/credits/ledger_list_by_external_id_response.rbi} +114 -114
- data/rbi/{lib/orb/models/customers/credits/ledger_list_by_external_id_response.rbi → orb/models/customers/credits/ledger_list_response.rbi} +114 -271
- data/rbi/{lib/orb → orb}/models/invoice.rbi +138 -156
- data/rbi/{lib/orb → orb}/models/invoice_fetch_upcoming_response.rbi +138 -150
- data/rbi/{lib/orb → orb}/models/invoice_line_item_create_response.rbi +138 -162
- data/rbi/{lib/orb → orb}/models/plan.rbi +105 -105
- data/rbi/{lib/orb → orb}/models/plan_create_params.rbi +973 -1734
- data/rbi/{lib/orb → orb}/models/price.rbi +1875 -2267
- data/rbi/{lib/orb → orb}/models/subscription.rbi +118 -118
- data/rbi/{lib/orb → orb}/models/subscription_cancel_response.rbi +118 -118
- data/rbi/{lib/orb → orb}/models/subscription_change_apply_response.rbi +118 -118
- data/rbi/{lib/orb → orb}/models/subscription_change_cancel_response.rbi +118 -118
- data/rbi/{lib/orb → orb}/models/subscription_change_retrieve_response.rbi +118 -118
- data/rbi/{lib/orb → orb}/models/subscription_create_params.rbi +1988 -2733
- data/rbi/{lib/orb → orb}/models/subscription_create_response.rbi +118 -118
- data/rbi/{lib/orb → orb}/models/subscription_fetch_costs_response.rbi +84 -84
- data/rbi/{lib/orb → orb}/models/subscription_price_intervals_params.rbi +1125 -1455
- data/rbi/{lib/orb → orb}/models/subscription_price_intervals_response.rbi +118 -118
- data/rbi/{lib/orb → orb}/models/subscription_schedule_plan_change_params.rbi +1988 -2210
- data/rbi/{lib/orb → orb}/models/subscription_schedule_plan_change_response.rbi +118 -118
- data/rbi/{lib/orb → orb}/models/subscription_trigger_phase_response.rbi +118 -118
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_cancellation_response.rbi +118 -118
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +118 -118
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_pending_plan_changes_response.rbi +118 -118
- data/rbi/{lib/orb → orb}/models/subscription_update_fixed_fee_quantity_response.rbi +118 -118
- data/rbi/{lib/orb → orb}/models/subscription_update_trial_response.rbi +118 -118
- data/rbi/orb/models.rbi +220 -0
- data/rbi/{lib/orb → orb}/request_options.rbi +2 -0
- data/rbi/{lib/orb → orb}/resources/alerts.rbi +8 -14
- data/rbi/{lib/orb → orb}/resources/coupons/subscriptions.rbi +1 -1
- data/rbi/{lib/orb → orb}/resources/coupons.rbi +6 -18
- data/rbi/{lib/orb → orb}/resources/credit_notes.rbi +3 -9
- data/rbi/{lib/orb → orb}/resources/customers/balance_transactions.rbi +2 -2
- data/rbi/{lib/orb → orb}/resources/customers/costs.rbi +2 -2
- data/rbi/{lib/orb → orb}/resources/customers/credits/ledger.rbi +32 -32
- data/rbi/{lib/orb → orb}/resources/customers/credits/top_ups.rbi +6 -18
- data/rbi/{lib/orb → orb}/resources/customers/credits.rbi +2 -2
- data/rbi/{lib/orb → orb}/resources/customers.rbi +15 -45
- data/rbi/{lib/orb → orb}/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi +1 -4
- data/rbi/{lib/orb → orb}/resources/dimensional_price_groups.rbi +3 -10
- data/rbi/{lib/orb → orb}/resources/events/backfills.rbi +5 -18
- data/rbi/{lib/orb → orb}/resources/events/volume.rbi +1 -1
- data/rbi/{lib/orb → orb}/resources/events.rbi +4 -10
- data/rbi/{lib/orb → orb}/resources/invoice_line_items.rbi +1 -1
- data/rbi/{lib/orb → orb}/resources/invoices.rbi +9 -34
- data/rbi/{lib/orb → orb}/resources/items.rbi +4 -17
- data/rbi/{lib/orb → orb}/resources/metrics.rbi +4 -10
- data/rbi/{lib/orb → orb}/resources/plans/external_plan_id.rbi +2 -8
- data/rbi/{lib/orb → orb}/resources/plans.rbi +29 -35
- data/rbi/orb/resources/prices/external_price_id.rbi +103 -0
- data/rbi/{lib/orb → orb}/resources/prices.rbi +117 -124
- data/rbi/{lib/orb → orb}/resources/subscription_changes.rbi +3 -9
- data/rbi/{lib/orb → orb}/resources/subscriptions.rbi +16 -32
- data/rbi/{lib/orb → orb}/resources/top_level.rbi +1 -4
- data/sig/orb/internal/util.rbs +2 -0
- data/sig/orb/models/coupon_create_params.rbs +9 -10
- data/sig/orb/models/customer_create_params.rbs +9 -10
- data/sig/orb/models/customer_update_by_external_id_params.rbs +9 -10
- data/sig/orb/models/customer_update_params.rbs +9 -10
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +113 -113
- data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +113 -113
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +113 -113
- data/sig/orb/models/customers/credits/ledger_list_response.rbs +113 -113
- data/sig/orb/models/invoice.rbs +54 -54
- data/sig/orb/models/invoice_fetch_upcoming_response.rbs +54 -54
- data/sig/orb/models/invoice_line_item_create_response.rbs +54 -54
- data/sig/orb/models/plan.rbs +21 -21
- data/sig/orb/models/plan_create_params.rbs +653 -653
- data/sig/orb/models/price.rbs +1517 -1521
- data/sig/orb/models/subscription.rbs +34 -34
- data/sig/orb/models/subscription_cancel_response.rbs +34 -34
- data/sig/orb/models/subscription_change_apply_response.rbs +34 -34
- data/sig/orb/models/subscription_change_cancel_response.rbs +34 -34
- data/sig/orb/models/subscription_change_retrieve_response.rbs +34 -34
- data/sig/orb/models/subscription_create_params.rbs +1348 -1348
- data/sig/orb/models/subscription_create_response.rbs +34 -34
- data/sig/orb/models/subscription_price_intervals_params.rbs +767 -769
- data/sig/orb/models/subscription_price_intervals_response.rbs +34 -34
- data/sig/orb/models/subscription_schedule_plan_change_params.rbs +1348 -1348
- data/sig/orb/models/subscription_schedule_plan_change_response.rbs +34 -34
- data/sig/orb/models/subscription_trigger_phase_response.rbs +34 -34
- data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +34 -34
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +34 -34
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +34 -34
- data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +34 -34
- data/sig/orb/models/subscription_update_trial_response.rbs +34 -34
- data/sig/orb/models.rbs +215 -0
- metadata +226 -223
- data/rbi/lib/orb/resources/prices/external_price_id.rbi +0 -106
- data/rbi/{lib/orb → orb}/client.rbi +0 -0
- data/rbi/{lib/orb → orb}/file_part.rbi +0 -0
- data/rbi/{lib/orb → orb}/internal/page.rbi +0 -0
- data/rbi/{lib/orb → orb}/internal/transport/pooled_net_requester.rbi +0 -0
- data/rbi/{lib/orb → orb}/internal/type/array_of.rbi +0 -0
- data/rbi/{lib/orb → orb}/internal/type/base_model.rbi +0 -0
- data/rbi/{lib/orb → orb}/internal/type/base_page.rbi +0 -0
- data/rbi/{lib/orb → orb}/internal/type/boolean.rbi +0 -0
- data/rbi/{lib/orb → orb}/internal/type/converter.rbi +0 -0
- data/rbi/{lib/orb → orb}/internal/type/enum.rbi +0 -0
- data/rbi/{lib/orb → orb}/internal/type/file_input.rbi +0 -0
- data/rbi/{lib/orb → orb}/internal/type/hash_of.rbi +0 -0
- data/rbi/{lib/orb → orb}/internal/type/union.rbi +0 -0
- data/rbi/{lib/orb → orb}/internal/type/unknown.rbi +0 -0
- data/rbi/{lib/orb → orb}/internal.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/alert.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/alert_create_for_customer_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/alert_create_for_external_customer_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/alert_create_for_subscription_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/alert_disable_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/alert_enable_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/alert_list_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/alert_retrieve_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/alert_update_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/amount_discount.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/billable_metric.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/billing_cycle_relative_date.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/coupon.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/coupon_archive_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/coupon_fetch_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/coupon_list_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/coupons/subscription_list_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/credit_note.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/credit_note_create_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/credit_note_fetch_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/credit_note_list_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customer.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customer_delete_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customer_fetch_by_external_id_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customer_fetch_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customer_list_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customer_sync_payment_methods_from_gateway_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/balance_transaction_create_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/balance_transaction_create_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/balance_transaction_list_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/balance_transaction_list_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/cost_list_by_external_id_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/cost_list_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credit_list_by_external_id_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credit_list_by_external_id_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credit_list_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credit_list_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_create_entry_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_list_by_external_id_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_list_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_by_external_id_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_by_external_id_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_delete_by_external_id_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_delete_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_by_external_id_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_by_external_id_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/dimensional_price_group.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/dimensional_price_group_create_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/dimensional_price_group_list_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/dimensional_price_group_retrieve_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/dimensional_price_groups.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/discount.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/evaluate_price_group.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/event_deprecate_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/event_deprecate_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/event_ingest_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/event_ingest_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/event_search_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/event_search_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/event_update_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/event_update_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_close_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_close_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_create_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_create_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_fetch_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_fetch_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_list_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_list_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_revert_params.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_revert_response.rbi +0 -0
- data/rbi/{lib/orb → orb}/models/events/event_volumes.rbi +2 -2
- /data/rbi/{lib/orb → orb}/models/events/volume_list_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_create_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_fetch_upcoming_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_issue_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_level_discount.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_line_item_create_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_list_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_mark_paid_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_pay_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_update_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/invoice_void_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/item.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/item_create_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/item_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/item_list_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/item_update_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/metric_create_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/metric_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/metric_list_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/metric_update_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/pagination_metadata.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/percentage_discount.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/plan_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/plan_list_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/plan_update_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/plans/external_plan_id_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/plans/external_plan_id_update_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/price_create_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/price_evaluate_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/price_evaluate_response.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/price_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/price_list_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/price_update_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/prices/external_price_id_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/prices/external_price_id_update_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_cancel_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_change_apply_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_change_cancel_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_change_retrieve_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_fetch_costs_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_fetch_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_fetch_schedule_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_fetch_schedule_response.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_fetch_usage_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_list_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_trigger_phase_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_unschedule_cancellation_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_unschedule_pending_plan_changes_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_update_fixed_fee_quantity_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_update_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_update_trial_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscription_usage.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/subscriptions.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/top_level_ping_params.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/top_level_ping_response.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/trial_discount.rbi +0 -0
- /data/rbi/{lib/orb → orb}/models/usage_discount.rbi +0 -0
- /data/rbi/{lib/orb → orb}/version.rbi +0 -0
@@ -22,7 +22,7 @@ module Orb
|
|
22
22
|
# invoice calculations (ie. usage discounts -> amount discounts -> percentage
|
23
23
|
# discounts -> minimums -> maximums).
|
24
24
|
#
|
25
|
-
# @return [Array<Orb::Models::InvoiceLineItemCreateResponse::Adjustment::
|
25
|
+
# @return [Array<Orb::Models::InvoiceLineItemCreateResponse::Adjustment::UsageDiscount, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::AmountDiscount, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::PercentageDiscount, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::Minimum, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::Maximum>]
|
26
26
|
required :adjustments,
|
27
27
|
-> { Orb::Internal::Type::ArrayOf[union: Orb::Models::InvoiceLineItemCreateResponse::Adjustment] }
|
28
28
|
|
@@ -120,7 +120,7 @@ module Orb
|
|
120
120
|
# For more on the types of prices, see
|
121
121
|
# [the core concepts documentation](/core-concepts#plan-and-price)
|
122
122
|
#
|
123
|
-
# @return [Orb::Models::Price::
|
123
|
+
# @return [Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBps, Orb::Models::Price::Bps, Orb::Models::Price::BulkBps, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk, nil]
|
124
124
|
required :price, union: -> { Orb::Models::Price }, nil?: true
|
125
125
|
|
126
126
|
# @!attribute quantity
|
@@ -139,7 +139,7 @@ module Orb
|
|
139
139
|
# For complex pricing structures, the line item can be broken down further in
|
140
140
|
# `sub_line_items`.
|
141
141
|
#
|
142
|
-
# @return [Array<Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::
|
142
|
+
# @return [Array<Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Matrix, Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Tier, Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Null>]
|
143
143
|
required :sub_line_items,
|
144
144
|
-> { Orb::Internal::Type::ArrayOf[union: Orb::Models::InvoiceLineItemCreateResponse::SubLineItem] }
|
145
145
|
|
@@ -172,7 +172,7 @@ module Orb
|
|
172
172
|
# @param adjusted_subtotal [String] The line amount after any adjustments and before overage conversion, credits and
|
173
173
|
# ...
|
174
174
|
#
|
175
|
-
# @param adjustments [Array<Orb::Models::InvoiceLineItemCreateResponse::Adjustment::
|
175
|
+
# @param adjustments [Array<Orb::Models::InvoiceLineItemCreateResponse::Adjustment::UsageDiscount, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::AmountDiscount, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::PercentageDiscount, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::Minimum, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::Maximum>] All adjustments applied to the line item in the order they were applied based on
|
176
176
|
# ...
|
177
177
|
#
|
178
178
|
# @param amount [String] The final amount for a line item after all adjustments and pre paid credits have
|
@@ -201,14 +201,14 @@ module Orb
|
|
201
201
|
#
|
202
202
|
# @param partially_invoiced_amount [String] Any amount applied from a partial invoice
|
203
203
|
#
|
204
|
-
# @param price [Orb::Models::Price::
|
204
|
+
# @param price [Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBps, Orb::Models::Price::Bps, Orb::Models::Price::BulkBps, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk, nil] The Price resource represents a price that can be billed on a subscription, resu
|
205
205
|
# ...
|
206
206
|
#
|
207
207
|
# @param quantity [Float] Either the fixed fee quantity or the usage during the service period.
|
208
208
|
#
|
209
209
|
# @param start_date [Time] The start date of the range of time applied for this line item's price.
|
210
210
|
#
|
211
|
-
# @param sub_line_items [Array<Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::
|
211
|
+
# @param sub_line_items [Array<Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Matrix, Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Tier, Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Null>] For complex pricing structures, the line item can be broken down further in `sub
|
212
212
|
# ...
|
213
213
|
#
|
214
214
|
# @param subtotal [String] The line amount before before any adjustments.
|
@@ -224,20 +224,18 @@ module Orb
|
|
224
224
|
|
225
225
|
discriminator :adjustment_type
|
226
226
|
|
227
|
-
variant :usage_discount,
|
228
|
-
-> { Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryUsageDiscountAdjustment }
|
227
|
+
variant :usage_discount, -> { Orb::Models::InvoiceLineItemCreateResponse::Adjustment::UsageDiscount }
|
229
228
|
|
230
|
-
variant :amount_discount,
|
231
|
-
-> { Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryAmountDiscountAdjustment }
|
229
|
+
variant :amount_discount, -> { Orb::Models::InvoiceLineItemCreateResponse::Adjustment::AmountDiscount }
|
232
230
|
|
233
231
|
variant :percentage_discount,
|
234
|
-
-> { Orb::Models::InvoiceLineItemCreateResponse::Adjustment::
|
232
|
+
-> { Orb::Models::InvoiceLineItemCreateResponse::Adjustment::PercentageDiscount }
|
235
233
|
|
236
|
-
variant :minimum, -> { Orb::Models::InvoiceLineItemCreateResponse::Adjustment::
|
234
|
+
variant :minimum, -> { Orb::Models::InvoiceLineItemCreateResponse::Adjustment::Minimum }
|
237
235
|
|
238
|
-
variant :maximum, -> { Orb::Models::InvoiceLineItemCreateResponse::Adjustment::
|
236
|
+
variant :maximum, -> { Orb::Models::InvoiceLineItemCreateResponse::Adjustment::Maximum }
|
239
237
|
|
240
|
-
class
|
238
|
+
class UsageDiscount < Orb::Internal::Type::BaseModel
|
241
239
|
# @!attribute id
|
242
240
|
#
|
243
241
|
# @return [String]
|
@@ -282,8 +280,8 @@ module Orb
|
|
282
280
|
|
283
281
|
# @!method initialize(id:, amount:, applies_to_price_ids:, is_invoice_level:, reason:, usage_discount:, adjustment_type: :usage_discount)
|
284
282
|
# Some parameter documentations has been truncated, see
|
285
|
-
# {Orb::Models::InvoiceLineItemCreateResponse::Adjustment::
|
286
|
-
#
|
283
|
+
# {Orb::Models::InvoiceLineItemCreateResponse::Adjustment::UsageDiscount} for more
|
284
|
+
# details.
|
287
285
|
#
|
288
286
|
# @param id [String]
|
289
287
|
#
|
@@ -302,7 +300,7 @@ module Orb
|
|
302
300
|
# @param adjustment_type [Symbol, :usage_discount]
|
303
301
|
end
|
304
302
|
|
305
|
-
class
|
303
|
+
class AmountDiscount < Orb::Internal::Type::BaseModel
|
306
304
|
# @!attribute id
|
307
305
|
#
|
308
306
|
# @return [String]
|
@@ -347,8 +345,8 @@ module Orb
|
|
347
345
|
|
348
346
|
# @!method initialize(id:, amount:, amount_discount:, applies_to_price_ids:, is_invoice_level:, reason:, adjustment_type: :amount_discount)
|
349
347
|
# Some parameter documentations has been truncated, see
|
350
|
-
# {Orb::Models::InvoiceLineItemCreateResponse::Adjustment::
|
351
|
-
#
|
348
|
+
# {Orb::Models::InvoiceLineItemCreateResponse::Adjustment::AmountDiscount} for
|
349
|
+
# more details.
|
352
350
|
#
|
353
351
|
# @param id [String]
|
354
352
|
#
|
@@ -367,7 +365,7 @@ module Orb
|
|
367
365
|
# @param adjustment_type [Symbol, :amount_discount]
|
368
366
|
end
|
369
367
|
|
370
|
-
class
|
368
|
+
class PercentageDiscount < Orb::Internal::Type::BaseModel
|
371
369
|
# @!attribute id
|
372
370
|
#
|
373
371
|
# @return [String]
|
@@ -412,8 +410,8 @@ module Orb
|
|
412
410
|
|
413
411
|
# @!method initialize(id:, amount:, applies_to_price_ids:, is_invoice_level:, percentage_discount:, reason:, adjustment_type: :percentage_discount)
|
414
412
|
# Some parameter documentations has been truncated, see
|
415
|
-
# {Orb::Models::InvoiceLineItemCreateResponse::Adjustment::
|
416
|
-
#
|
413
|
+
# {Orb::Models::InvoiceLineItemCreateResponse::Adjustment::PercentageDiscount} for
|
414
|
+
# more details.
|
417
415
|
#
|
418
416
|
# @param id [String]
|
419
417
|
#
|
@@ -432,7 +430,7 @@ module Orb
|
|
432
430
|
# @param adjustment_type [Symbol, :percentage_discount]
|
433
431
|
end
|
434
432
|
|
435
|
-
class
|
433
|
+
class Minimum < Orb::Internal::Type::BaseModel
|
436
434
|
# @!attribute id
|
437
435
|
#
|
438
436
|
# @return [String]
|
@@ -483,8 +481,8 @@ module Orb
|
|
483
481
|
|
484
482
|
# @!method initialize(id:, amount:, applies_to_price_ids:, is_invoice_level:, item_id:, minimum_amount:, reason:, adjustment_type: :minimum)
|
485
483
|
# Some parameter documentations has been truncated, see
|
486
|
-
# {Orb::Models::InvoiceLineItemCreateResponse::Adjustment::
|
487
|
-
#
|
484
|
+
# {Orb::Models::InvoiceLineItemCreateResponse::Adjustment::Minimum} for more
|
485
|
+
# details.
|
488
486
|
#
|
489
487
|
# @param id [String]
|
490
488
|
#
|
@@ -505,7 +503,7 @@ module Orb
|
|
505
503
|
# @param adjustment_type [Symbol, :minimum]
|
506
504
|
end
|
507
505
|
|
508
|
-
class
|
506
|
+
class Maximum < Orb::Internal::Type::BaseModel
|
509
507
|
# @!attribute id
|
510
508
|
#
|
511
509
|
# @return [String]
|
@@ -550,8 +548,8 @@ module Orb
|
|
550
548
|
|
551
549
|
# @!method initialize(id:, amount:, applies_to_price_ids:, is_invoice_level:, maximum_amount:, reason:, adjustment_type: :maximum)
|
552
550
|
# Some parameter documentations has been truncated, see
|
553
|
-
# {Orb::Models::InvoiceLineItemCreateResponse::Adjustment::
|
554
|
-
#
|
551
|
+
# {Orb::Models::InvoiceLineItemCreateResponse::Adjustment::Maximum} for more
|
552
|
+
# details.
|
555
553
|
#
|
556
554
|
# @param id [String]
|
557
555
|
#
|
@@ -571,7 +569,7 @@ module Orb
|
|
571
569
|
end
|
572
570
|
|
573
571
|
# @!method self.variants
|
574
|
-
# @return [Array(Orb::Models::InvoiceLineItemCreateResponse::Adjustment::
|
572
|
+
# @return [Array(Orb::Models::InvoiceLineItemCreateResponse::Adjustment::UsageDiscount, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::AmountDiscount, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::PercentageDiscount, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::Minimum, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::Maximum)]
|
575
573
|
end
|
576
574
|
|
577
575
|
# @deprecated
|
@@ -637,13 +635,13 @@ module Orb
|
|
637
635
|
|
638
636
|
discriminator :type
|
639
637
|
|
640
|
-
variant :matrix, -> { Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::
|
638
|
+
variant :matrix, -> { Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Matrix }
|
641
639
|
|
642
|
-
variant :tier, -> { Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::
|
640
|
+
variant :tier, -> { Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Tier }
|
643
641
|
|
644
|
-
variant :"'null'", -> { Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::
|
642
|
+
variant :"'null'", -> { Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Null }
|
645
643
|
|
646
|
-
class
|
644
|
+
class Matrix < Orb::Internal::Type::BaseModel
|
647
645
|
# @!attribute amount
|
648
646
|
# The total amount for this sub line item.
|
649
647
|
#
|
@@ -652,16 +650,16 @@ module Orb
|
|
652
650
|
|
653
651
|
# @!attribute grouping
|
654
652
|
#
|
655
|
-
# @return [Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::
|
653
|
+
# @return [Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Matrix::Grouping, nil]
|
656
654
|
required :grouping,
|
657
|
-
-> { Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::
|
655
|
+
-> { Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Matrix::Grouping },
|
658
656
|
nil?: true
|
659
657
|
|
660
658
|
# @!attribute matrix_config
|
661
659
|
#
|
662
|
-
# @return [Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::
|
660
|
+
# @return [Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Matrix::MatrixConfig]
|
663
661
|
required :matrix_config,
|
664
|
-
-> { Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::
|
662
|
+
-> { Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Matrix::MatrixConfig }
|
665
663
|
|
666
664
|
# @!attribute name
|
667
665
|
#
|
@@ -681,9 +679,9 @@ module Orb
|
|
681
679
|
# @!method initialize(amount:, grouping:, matrix_config:, name:, quantity:, type: :matrix)
|
682
680
|
# @param amount [String] The total amount for this sub line item.
|
683
681
|
#
|
684
|
-
# @param grouping [Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::
|
682
|
+
# @param grouping [Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Matrix::Grouping, nil]
|
685
683
|
#
|
686
|
-
# @param matrix_config [Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::
|
684
|
+
# @param matrix_config [Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Matrix::MatrixConfig]
|
687
685
|
#
|
688
686
|
# @param name [String]
|
689
687
|
#
|
@@ -691,7 +689,7 @@ module Orb
|
|
691
689
|
#
|
692
690
|
# @param type [Symbol, :matrix]
|
693
691
|
|
694
|
-
# @see Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::
|
692
|
+
# @see Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Matrix#grouping
|
695
693
|
class Grouping < Orb::Internal::Type::BaseModel
|
696
694
|
# @!attribute key
|
697
695
|
#
|
@@ -710,7 +708,7 @@ module Orb
|
|
710
708
|
# @param value [String, nil] No value indicates the default group
|
711
709
|
end
|
712
710
|
|
713
|
-
# @see Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::
|
711
|
+
# @see Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Matrix#matrix_config
|
714
712
|
class MatrixConfig < Orb::Internal::Type::BaseModel
|
715
713
|
# @!attribute dimension_values
|
716
714
|
# The ordered dimension values for this line item.
|
@@ -723,7 +721,7 @@ module Orb
|
|
723
721
|
end
|
724
722
|
end
|
725
723
|
|
726
|
-
class
|
724
|
+
class Tier < Orb::Internal::Type::BaseModel
|
727
725
|
# @!attribute amount
|
728
726
|
# The total amount for this sub line item.
|
729
727
|
#
|
@@ -732,9 +730,9 @@ module Orb
|
|
732
730
|
|
733
731
|
# @!attribute grouping
|
734
732
|
#
|
735
|
-
# @return [Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::
|
733
|
+
# @return [Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Tier::Grouping, nil]
|
736
734
|
required :grouping,
|
737
|
-
-> { Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::
|
735
|
+
-> { Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Tier::Grouping },
|
738
736
|
nil?: true
|
739
737
|
|
740
738
|
# @!attribute name
|
@@ -749,9 +747,8 @@ module Orb
|
|
749
747
|
|
750
748
|
# @!attribute tier_config
|
751
749
|
#
|
752
|
-
# @return [Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::
|
753
|
-
required :tier_config,
|
754
|
-
-> { Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::TierSubLineItem::TierConfig }
|
750
|
+
# @return [Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Tier::TierConfig]
|
751
|
+
required :tier_config, -> { Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Tier::TierConfig }
|
755
752
|
|
756
753
|
# @!attribute type
|
757
754
|
#
|
@@ -761,17 +758,17 @@ module Orb
|
|
761
758
|
# @!method initialize(amount:, grouping:, name:, quantity:, tier_config:, type: :tier)
|
762
759
|
# @param amount [String] The total amount for this sub line item.
|
763
760
|
#
|
764
|
-
# @param grouping [Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::
|
761
|
+
# @param grouping [Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Tier::Grouping, nil]
|
765
762
|
#
|
766
763
|
# @param name [String]
|
767
764
|
#
|
768
765
|
# @param quantity [Float]
|
769
766
|
#
|
770
|
-
# @param tier_config [Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::
|
767
|
+
# @param tier_config [Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Tier::TierConfig]
|
771
768
|
#
|
772
769
|
# @param type [Symbol, :tier]
|
773
770
|
|
774
|
-
# @see Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::
|
771
|
+
# @see Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Tier#grouping
|
775
772
|
class Grouping < Orb::Internal::Type::BaseModel
|
776
773
|
# @!attribute key
|
777
774
|
#
|
@@ -790,7 +787,7 @@ module Orb
|
|
790
787
|
# @param value [String, nil] No value indicates the default group
|
791
788
|
end
|
792
789
|
|
793
|
-
# @see Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::
|
790
|
+
# @see Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Tier#tier_config
|
794
791
|
class TierConfig < Orb::Internal::Type::BaseModel
|
795
792
|
# @!attribute first_unit
|
796
793
|
#
|
@@ -814,7 +811,7 @@ module Orb
|
|
814
811
|
end
|
815
812
|
end
|
816
813
|
|
817
|
-
class
|
814
|
+
class Null < Orb::Internal::Type::BaseModel
|
818
815
|
# @!attribute amount
|
819
816
|
# The total amount for this sub line item.
|
820
817
|
#
|
@@ -823,9 +820,9 @@ module Orb
|
|
823
820
|
|
824
821
|
# @!attribute grouping
|
825
822
|
#
|
826
|
-
# @return [Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::
|
823
|
+
# @return [Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Null::Grouping, nil]
|
827
824
|
required :grouping,
|
828
|
-
-> { Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::
|
825
|
+
-> { Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Null::Grouping },
|
829
826
|
nil?: true
|
830
827
|
|
831
828
|
# @!attribute name
|
@@ -846,7 +843,7 @@ module Orb
|
|
846
843
|
# @!method initialize(amount:, grouping:, name:, quantity:, type: :"'null'")
|
847
844
|
# @param amount [String] The total amount for this sub line item.
|
848
845
|
#
|
849
|
-
# @param grouping [Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::
|
846
|
+
# @param grouping [Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Null::Grouping, nil]
|
850
847
|
#
|
851
848
|
# @param name [String]
|
852
849
|
#
|
@@ -854,7 +851,7 @@ module Orb
|
|
854
851
|
#
|
855
852
|
# @param type [Symbol, :"'null'"]
|
856
853
|
|
857
|
-
# @see Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::
|
854
|
+
# @see Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Null#grouping
|
858
855
|
class Grouping < Orb::Internal::Type::BaseModel
|
859
856
|
# @!attribute key
|
860
857
|
#
|
@@ -875,7 +872,7 @@ module Orb
|
|
875
872
|
end
|
876
873
|
|
877
874
|
# @!method self.variants
|
878
|
-
# @return [Array(Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::
|
875
|
+
# @return [Array(Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Matrix, Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Tier, Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Null)]
|
879
876
|
end
|
880
877
|
|
881
878
|
class TaxAmount < Orb::Internal::Type::BaseModel
|
data/lib/orb/models/plan.rb
CHANGED
@@ -13,7 +13,7 @@ module Orb
|
|
13
13
|
# Adjustments for this plan. If the plan has phases, this includes adjustments
|
14
14
|
# across all phases of the plan.
|
15
15
|
#
|
16
|
-
# @return [Array<Orb::Models::Plan::Adjustment::
|
16
|
+
# @return [Array<Orb::Models::Plan::Adjustment::UsageDiscount, Orb::Models::Plan::Adjustment::AmountDiscount, Orb::Models::Plan::Adjustment::PercentageDiscount, Orb::Models::Plan::Adjustment::Minimum, Orb::Models::Plan::Adjustment::Maximum>]
|
17
17
|
required :adjustments, -> { Orb::Internal::Type::ArrayOf[union: Orb::Models::Plan::Adjustment] }
|
18
18
|
|
19
19
|
# @!attribute base_plan
|
@@ -127,7 +127,7 @@ module Orb
|
|
127
127
|
# Prices for this plan. If the plan has phases, this includes prices across all
|
128
128
|
# phases of the plan.
|
129
129
|
#
|
130
|
-
# @return [Array<Orb::Models::Price::
|
130
|
+
# @return [Array<Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBps, Orb::Models::Price::Bps, Orb::Models::Price::BulkBps, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk>]
|
131
131
|
required :prices, -> { Orb::Internal::Type::ArrayOf[union: Orb::Models::Price] }
|
132
132
|
|
133
133
|
# @!attribute product
|
@@ -161,7 +161,7 @@ module Orb
|
|
161
161
|
#
|
162
162
|
# @param id [String]
|
163
163
|
#
|
164
|
-
# @param adjustments [Array<Orb::Models::Plan::Adjustment::
|
164
|
+
# @param adjustments [Array<Orb::Models::Plan::Adjustment::UsageDiscount, Orb::Models::Plan::Adjustment::AmountDiscount, Orb::Models::Plan::Adjustment::PercentageDiscount, Orb::Models::Plan::Adjustment::Minimum, Orb::Models::Plan::Adjustment::Maximum>] Adjustments for this plan. If the plan has phases, this includes adjustments acr
|
165
165
|
# ...
|
166
166
|
#
|
167
167
|
# @param base_plan [Orb::Models::Plan::BasePlan, nil]
|
@@ -205,7 +205,7 @@ module Orb
|
|
205
205
|
#
|
206
206
|
# @param plan_phases [Array<Orb::Models::Plan::PlanPhase>, nil]
|
207
207
|
#
|
208
|
-
# @param prices [Array<Orb::Models::Price::
|
208
|
+
# @param prices [Array<Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBps, Orb::Models::Price::Bps, Orb::Models::Price::BulkBps, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk>] Prices for this plan. If the plan has phases, this includes prices across all ph
|
209
209
|
# ...
|
210
210
|
#
|
211
211
|
# @param product [Orb::Models::Plan::Product]
|
@@ -221,17 +221,17 @@ module Orb
|
|
221
221
|
|
222
222
|
discriminator :adjustment_type
|
223
223
|
|
224
|
-
variant :usage_discount, -> { Orb::Models::Plan::Adjustment::
|
224
|
+
variant :usage_discount, -> { Orb::Models::Plan::Adjustment::UsageDiscount }
|
225
225
|
|
226
|
-
variant :amount_discount, -> { Orb::Models::Plan::Adjustment::
|
226
|
+
variant :amount_discount, -> { Orb::Models::Plan::Adjustment::AmountDiscount }
|
227
227
|
|
228
|
-
variant :percentage_discount, -> { Orb::Models::Plan::Adjustment::
|
228
|
+
variant :percentage_discount, -> { Orb::Models::Plan::Adjustment::PercentageDiscount }
|
229
229
|
|
230
|
-
variant :minimum, -> { Orb::Models::Plan::Adjustment::
|
230
|
+
variant :minimum, -> { Orb::Models::Plan::Adjustment::Minimum }
|
231
231
|
|
232
|
-
variant :maximum, -> { Orb::Models::Plan::Adjustment::
|
232
|
+
variant :maximum, -> { Orb::Models::Plan::Adjustment::Maximum }
|
233
233
|
|
234
|
-
class
|
234
|
+
class UsageDiscount < Orb::Internal::Type::BaseModel
|
235
235
|
# @!attribute id
|
236
236
|
#
|
237
237
|
# @return [String]
|
@@ -276,8 +276,7 @@ module Orb
|
|
276
276
|
|
277
277
|
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, usage_discount:, adjustment_type: :usage_discount)
|
278
278
|
# Some parameter documentations has been truncated, see
|
279
|
-
# {Orb::Models::Plan::Adjustment::
|
280
|
-
# details.
|
279
|
+
# {Orb::Models::Plan::Adjustment::UsageDiscount} for more details.
|
281
280
|
#
|
282
281
|
# @param id [String]
|
283
282
|
#
|
@@ -296,7 +295,7 @@ module Orb
|
|
296
295
|
# @param adjustment_type [Symbol, :usage_discount]
|
297
296
|
end
|
298
297
|
|
299
|
-
class
|
298
|
+
class AmountDiscount < Orb::Internal::Type::BaseModel
|
300
299
|
# @!attribute id
|
301
300
|
#
|
302
301
|
# @return [String]
|
@@ -341,8 +340,7 @@ module Orb
|
|
341
340
|
|
342
341
|
# @!method initialize(id:, amount_discount:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, adjustment_type: :amount_discount)
|
343
342
|
# Some parameter documentations has been truncated, see
|
344
|
-
# {Orb::Models::Plan::Adjustment::
|
345
|
-
# details.
|
343
|
+
# {Orb::Models::Plan::Adjustment::AmountDiscount} for more details.
|
346
344
|
#
|
347
345
|
# @param id [String]
|
348
346
|
#
|
@@ -361,7 +359,7 @@ module Orb
|
|
361
359
|
# @param adjustment_type [Symbol, :amount_discount]
|
362
360
|
end
|
363
361
|
|
364
|
-
class
|
362
|
+
class PercentageDiscount < Orb::Internal::Type::BaseModel
|
365
363
|
# @!attribute id
|
366
364
|
#
|
367
365
|
# @return [String]
|
@@ -406,8 +404,7 @@ module Orb
|
|
406
404
|
|
407
405
|
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, percentage_discount:, plan_phase_order:, reason:, adjustment_type: :percentage_discount)
|
408
406
|
# Some parameter documentations has been truncated, see
|
409
|
-
# {Orb::Models::Plan::Adjustment::
|
410
|
-
# details.
|
407
|
+
# {Orb::Models::Plan::Adjustment::PercentageDiscount} for more details.
|
411
408
|
#
|
412
409
|
# @param id [String]
|
413
410
|
#
|
@@ -426,7 +423,7 @@ module Orb
|
|
426
423
|
# @param adjustment_type [Symbol, :percentage_discount]
|
427
424
|
end
|
428
425
|
|
429
|
-
class
|
426
|
+
class Minimum < Orb::Internal::Type::BaseModel
|
430
427
|
# @!attribute id
|
431
428
|
#
|
432
429
|
# @return [String]
|
@@ -477,7 +474,7 @@ module Orb
|
|
477
474
|
|
478
475
|
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, item_id:, minimum_amount:, plan_phase_order:, reason:, adjustment_type: :minimum)
|
479
476
|
# Some parameter documentations has been truncated, see
|
480
|
-
# {Orb::Models::Plan::Adjustment::
|
477
|
+
# {Orb::Models::Plan::Adjustment::Minimum} for more details.
|
481
478
|
#
|
482
479
|
# @param id [String]
|
483
480
|
#
|
@@ -498,7 +495,7 @@ module Orb
|
|
498
495
|
# @param adjustment_type [Symbol, :minimum]
|
499
496
|
end
|
500
497
|
|
501
|
-
class
|
498
|
+
class Maximum < Orb::Internal::Type::BaseModel
|
502
499
|
# @!attribute id
|
503
500
|
#
|
504
501
|
# @return [String]
|
@@ -543,7 +540,7 @@ module Orb
|
|
543
540
|
|
544
541
|
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, maximum_amount:, plan_phase_order:, reason:, adjustment_type: :maximum)
|
545
542
|
# Some parameter documentations has been truncated, see
|
546
|
-
# {Orb::Models::Plan::Adjustment::
|
543
|
+
# {Orb::Models::Plan::Adjustment::Maximum} for more details.
|
547
544
|
#
|
548
545
|
# @param id [String]
|
549
546
|
#
|
@@ -563,7 +560,7 @@ module Orb
|
|
563
560
|
end
|
564
561
|
|
565
562
|
# @!method self.variants
|
566
|
-
# @return [Array(Orb::Models::Plan::Adjustment::
|
563
|
+
# @return [Array(Orb::Models::Plan::Adjustment::UsageDiscount, Orb::Models::Plan::Adjustment::AmountDiscount, Orb::Models::Plan::Adjustment::PercentageDiscount, Orb::Models::Plan::Adjustment::Minimum, Orb::Models::Plan::Adjustment::Maximum)]
|
567
564
|
end
|
568
565
|
|
569
566
|
# @see Orb::Models::Plan#base_plan
|