orb-billing 0.1.0.pre.alpha.33
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 +7 -0
- data/README.md +169 -0
- data/lib/orb/client.rb +129 -0
- data/lib/orb/errors.rb +317 -0
- data/lib/orb/models/alert.rb +225 -0
- data/lib/orb/models/alert_create_for_customer_params.rb +77 -0
- data/lib/orb/models/alert_create_for_external_customer_params.rb +77 -0
- data/lib/orb/models/alert_create_for_subscription_params.rb +74 -0
- data/lib/orb/models/alert_disable_params.rb +26 -0
- data/lib/orb/models/alert_enable_params.rb +26 -0
- data/lib/orb/models/alert_list_params.rb +97 -0
- data/lib/orb/models/alert_retrieve_params.rb +19 -0
- data/lib/orb/models/alert_update_params.rb +46 -0
- data/lib/orb/models/amount_discount.rb +53 -0
- data/lib/orb/models/billable_metric.rb +76 -0
- data/lib/orb/models/billing_cycle_relative_date.rb +18 -0
- data/lib/orb/models/coupon.rb +86 -0
- data/lib/orb/models/coupon_archive_params.rb +19 -0
- data/lib/orb/models/coupon_create_params.rb +102 -0
- data/lib/orb/models/coupon_fetch_params.rb +19 -0
- data/lib/orb/models/coupon_list_params.rb +53 -0
- data/lib/orb/models/coupons/subscription_list_params.rb +40 -0
- data/lib/orb/models/credit_note.rb +522 -0
- data/lib/orb/models/credit_note_create_params.rb +77 -0
- data/lib/orb/models/credit_note_fetch_params.rb +19 -0
- data/lib/orb/models/credit_note_list_params.rb +73 -0
- data/lib/orb/models/customer.rb +872 -0
- data/lib/orb/models/customer_create_params.rb +843 -0
- data/lib/orb/models/customer_delete_params.rb +19 -0
- data/lib/orb/models/customer_fetch_by_external_id_params.rb +19 -0
- data/lib/orb/models/customer_fetch_params.rb +19 -0
- data/lib/orb/models/customer_list_params.rb +73 -0
- data/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rb +19 -0
- data/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rb +19 -0
- data/lib/orb/models/customer_update_by_external_id_params.rb +848 -0
- data/lib/orb/models/customer_update_params.rb +838 -0
- data/lib/orb/models/customers/balance_transaction_create_params.rb +53 -0
- data/lib/orb/models/customers/balance_transaction_create_response.rb +167 -0
- data/lib/orb/models/customers/balance_transaction_list_params.rb +75 -0
- data/lib/orb/models/customers/balance_transaction_list_response.rb +167 -0
- data/lib/orb/models/customers/cost_list_by_external_id_params.rb +69 -0
- data/lib/orb/models/customers/cost_list_by_external_id_response.rb +106 -0
- data/lib/orb/models/customers/cost_list_params.rb +69 -0
- data/lib/orb/models/customers/cost_list_response.rb +106 -0
- data/lib/orb/models/customers/credit_list_by_external_id_params.rb +59 -0
- data/lib/orb/models/customers/credit_list_by_external_id_response.rb +72 -0
- data/lib/orb/models/customers/credit_list_params.rb +59 -0
- data/lib/orb/models/customers/credit_list_response.rb +72 -0
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +215 -0
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +1311 -0
- data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +214 -0
- data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +1310 -0
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +141 -0
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +1310 -0
- data/lib/orb/models/customers/credits/ledger_list_params.rb +141 -0
- data/lib/orb/models/customers/credits/ledger_list_response.rb +1306 -0
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +159 -0
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +154 -0
- data/lib/orb/models/customers/credits/top_up_create_params.rb +158 -0
- data/lib/orb/models/customers/credits/top_up_create_response.rb +153 -0
- data/lib/orb/models/customers/credits/top_up_delete_by_external_id_params.rb +29 -0
- data/lib/orb/models/customers/credits/top_up_delete_params.rb +29 -0
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +42 -0
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +154 -0
- data/lib/orb/models/customers/credits/top_up_list_params.rb +42 -0
- data/lib/orb/models/customers/credits/top_up_list_response.rb +153 -0
- data/lib/orb/models/dimensional_price_group.rb +64 -0
- data/lib/orb/models/dimensional_price_group_create_params.rb +63 -0
- data/lib/orb/models/dimensional_price_group_list_params.rb +38 -0
- data/lib/orb/models/dimensional_price_group_retrieve_params.rb +19 -0
- data/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rb +21 -0
- data/lib/orb/models/dimensional_price_groups.rb +25 -0
- data/lib/orb/models/discount.rb +23 -0
- data/lib/orb/models/evaluate_price_group.rb +48 -0
- data/lib/orb/models/event_deprecate_params.rb +19 -0
- data/lib/orb/models/event_deprecate_response.rb +21 -0
- data/lib/orb/models/event_ingest_params.rb +100 -0
- data/lib/orb/models/event_ingest_response.rb +77 -0
- data/lib/orb/models/event_search_params.rb +45 -0
- data/lib/orb/models/event_search_response.rb +87 -0
- data/lib/orb/models/event_update_params.rb +58 -0
- data/lib/orb/models/event_update_response.rb +21 -0
- data/lib/orb/models/events/backfill_close_params.rb +21 -0
- data/lib/orb/models/events/backfill_close_response.rb +131 -0
- data/lib/orb/models/events/backfill_create_params.rb +97 -0
- data/lib/orb/models/events/backfill_create_response.rb +131 -0
- data/lib/orb/models/events/backfill_fetch_params.rb +21 -0
- data/lib/orb/models/events/backfill_fetch_response.rb +131 -0
- data/lib/orb/models/events/backfill_list_params.rb +40 -0
- data/lib/orb/models/events/backfill_list_response.rb +131 -0
- data/lib/orb/models/events/backfill_revert_params.rb +21 -0
- data/lib/orb/models/events/backfill_revert_response.rb +131 -0
- data/lib/orb/models/events/event_volumes.rb +54 -0
- data/lib/orb/models/events/volume_list_params.rb +64 -0
- data/lib/orb/models/invoice.rb +2218 -0
- data/lib/orb/models/invoice_create_params.rb +200 -0
- data/lib/orb/models/invoice_fetch_params.rb +19 -0
- data/lib/orb/models/invoice_fetch_upcoming_params.rb +25 -0
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +2226 -0
- data/lib/orb/models/invoice_issue_params.rb +34 -0
- data/lib/orb/models/invoice_level_discount.rb +21 -0
- data/lib/orb/models/invoice_line_item_create_params.rb +62 -0
- data/lib/orb/models/invoice_line_item_create_response.rb +929 -0
- data/lib/orb/models/invoice_list_params.rb +197 -0
- data/lib/orb/models/invoice_mark_paid_params.rb +40 -0
- data/lib/orb/models/invoice_pay_params.rb +19 -0
- data/lib/orb/models/invoice_update_params.rb +28 -0
- data/lib/orb/models/invoice_void_params.rb +19 -0
- data/lib/orb/models/item.rb +82 -0
- data/lib/orb/models/item_create_params.rb +26 -0
- data/lib/orb/models/item_fetch_params.rb +19 -0
- data/lib/orb/models/item_list_params.rb +38 -0
- data/lib/orb/models/item_update_params.rb +73 -0
- data/lib/orb/models/metric_create_params.rb +56 -0
- data/lib/orb/models/metric_fetch_params.rb +19 -0
- data/lib/orb/models/metric_list_params.rb +73 -0
- data/lib/orb/models/metric_update_params.rb +28 -0
- data/lib/orb/models/pagination_metadata.rb +25 -0
- data/lib/orb/models/percentage_discount.rb +54 -0
- data/lib/orb/models/plan.rb +894 -0
- data/lib/orb/models/plan_create_params.rb +6702 -0
- data/lib/orb/models/plan_fetch_params.rb +19 -0
- data/lib/orb/models/plan_list_params.rb +100 -0
- data/lib/orb/models/plan_update_params.rb +37 -0
- data/lib/orb/models/plans/external_plan_id_fetch_params.rb +21 -0
- data/lib/orb/models/plans/external_plan_id_update_params.rb +39 -0
- data/lib/orb/models/price.rb +12229 -0
- data/lib/orb/models/price_create_params.rb +808 -0
- data/lib/orb/models/price_evaluate_params.rb +80 -0
- data/lib/orb/models/price_evaluate_response.rb +20 -0
- data/lib/orb/models/price_fetch_params.rb +19 -0
- data/lib/orb/models/price_list_params.rb +38 -0
- data/lib/orb/models/price_update_params.rb +28 -0
- data/lib/orb/models/prices/external_price_id_fetch_params.rb +21 -0
- data/lib/orb/models/prices/external_price_id_update_params.rb +30 -0
- data/lib/orb/models/subscription.rb +1233 -0
- data/lib/orb/models/subscription_cancel_params.rb +58 -0
- data/lib/orb/models/subscription_cancel_response.rb +1217 -0
- data/lib/orb/models/subscription_create_params.rb +15065 -0
- data/lib/orb/models/subscription_create_response.rb +1217 -0
- data/lib/orb/models/subscription_fetch_costs_params.rb +67 -0
- data/lib/orb/models/subscription_fetch_costs_response.rb +104 -0
- data/lib/orb/models/subscription_fetch_params.rb +19 -0
- data/lib/orb/models/subscription_fetch_schedule_params.rb +73 -0
- data/lib/orb/models/subscription_fetch_schedule_response.rb +68 -0
- data/lib/orb/models/subscription_fetch_usage_params.rb +135 -0
- data/lib/orb/models/subscription_list_params.rb +108 -0
- data/lib/orb/models/subscription_price_intervals_params.rb +8358 -0
- data/lib/orb/models/subscription_price_intervals_response.rb +1224 -0
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +15088 -0
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +1224 -0
- data/lib/orb/models/subscription_trigger_phase_params.rb +36 -0
- data/lib/orb/models/subscription_trigger_phase_response.rb +1224 -0
- data/lib/orb/models/subscription_unschedule_cancellation_params.rb +19 -0
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +1224 -0
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rb +26 -0
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +1228 -0
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rb +19 -0
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +1224 -0
- data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +90 -0
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +1224 -0
- data/lib/orb/models/subscription_update_params.rb +74 -0
- data/lib/orb/models/subscription_update_trial_params.rb +59 -0
- data/lib/orb/models/subscription_update_trial_response.rb +1222 -0
- data/lib/orb/models/subscription_usage.rb +258 -0
- data/lib/orb/models/subscriptions.rb +25 -0
- data/lib/orb/models/top_level_ping_params.rb +19 -0
- data/lib/orb/models/top_level_ping_response.rb +20 -0
- data/lib/orb/models/trial_discount.rb +69 -0
- data/lib/orb/models/usage_discount.rb +54 -0
- data/lib/orb/page.rb +114 -0
- data/lib/orb/request_options.rb +75 -0
- data/lib/orb/resources/alerts.rb +239 -0
- data/lib/orb/resources/coupons/subscriptions.rb +43 -0
- data/lib/orb/resources/coupons.rb +115 -0
- data/lib/orb/resources/credit_notes.rb +87 -0
- data/lib/orb/resources/customers/balance_transactions.rb +96 -0
- data/lib/orb/resources/customers/costs.rb +298 -0
- data/lib/orb/resources/customers/credits/ledger.rb +527 -0
- data/lib/orb/resources/customers/credits/top_ups.rb +192 -0
- data/lib/orb/resources/customers/credits.rb +88 -0
- data/lib/orb/resources/customers.rb +321 -0
- data/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rb +38 -0
- data/lib/orb/resources/dimensional_price_groups.rb +93 -0
- data/lib/orb/resources/events/backfills.rb +174 -0
- data/lib/orb/resources/events/volume.rb +52 -0
- data/lib/orb/resources/events.rb +415 -0
- data/lib/orb/resources/invoice_line_items.rb +41 -0
- data/lib/orb/resources/invoices.rb +266 -0
- data/lib/orb/resources/items.rb +95 -0
- data/lib/orb/resources/metrics.rb +114 -0
- data/lib/orb/resources/plans/external_plan_id.rb +76 -0
- data/lib/orb/resources/plans.rb +133 -0
- data/lib/orb/resources/prices/external_price_id.rb +61 -0
- data/lib/orb/resources/prices.rb +197 -0
- data/lib/orb/resources/subscriptions.rb +1278 -0
- data/lib/orb/resources/top_level.rb +37 -0
- data/lib/orb/transport/base_client.rb +459 -0
- data/lib/orb/transport/pooled_net_requester.rb +182 -0
- data/lib/orb/type/array_of.rb +112 -0
- data/lib/orb/type/base_model.rb +367 -0
- data/lib/orb/type/base_page.rb +61 -0
- data/lib/orb/type/boolean_model.rb +52 -0
- data/lib/orb/type/converter.rb +217 -0
- data/lib/orb/type/enum.rb +101 -0
- data/lib/orb/type/hash_of.rb +132 -0
- data/lib/orb/type/request_parameters.rb +38 -0
- data/lib/orb/type/union.rb +225 -0
- data/lib/orb/type/unknown.rb +56 -0
- data/lib/orb/type.rb +23 -0
- data/lib/orb/util.rb +722 -0
- data/lib/orb/version.rb +5 -0
- data/lib/orb.rb +247 -0
- data/manifest.yaml +15 -0
- data/rbi/lib/orb/client.rbi +90 -0
- data/rbi/lib/orb/errors.rbi +246 -0
- data/rbi/lib/orb/models/alert.rbi +239 -0
- data/rbi/lib/orb/models/alert_create_for_customer_params.rbi +86 -0
- data/rbi/lib/orb/models/alert_create_for_external_customer_params.rbi +88 -0
- data/rbi/lib/orb/models/alert_create_for_subscription_params.rbi +83 -0
- data/rbi/lib/orb/models/alert_disable_params.rbi +28 -0
- data/rbi/lib/orb/models/alert_enable_params.rbi +28 -0
- data/rbi/lib/orb/models/alert_list_params.rbi +95 -0
- data/rbi/lib/orb/models/alert_retrieve_params.rbi +20 -0
- data/rbi/lib/orb/models/alert_update_params.rbi +51 -0
- data/rbi/lib/orb/models/amount_discount.rbi +62 -0
- data/rbi/lib/orb/models/billable_metric.rbi +83 -0
- data/rbi/lib/orb/models/billing_cycle_relative_date.rbi +19 -0
- data/rbi/lib/orb/models/coupon.rbi +90 -0
- data/rbi/lib/orb/models/coupon_archive_params.rbi +20 -0
- data/rbi/lib/orb/models/coupon_create_params.rbi +120 -0
- data/rbi/lib/orb/models/coupon_fetch_params.rbi +20 -0
- data/rbi/lib/orb/models/coupon_list_params.rbi +59 -0
- data/rbi/lib/orb/models/coupons/subscription_list_params.rbi +41 -0
- data/rbi/lib/orb/models/credit_note.rbi +546 -0
- data/rbi/lib/orb/models/credit_note_create_params.rbi +84 -0
- data/rbi/lib/orb/models/credit_note_fetch_params.rbi +20 -0
- data/rbi/lib/orb/models/credit_note_list_params.rbi +74 -0
- data/rbi/lib/orb/models/customer.rbi +941 -0
- data/rbi/lib/orb/models/customer_create_params.rbi +923 -0
- data/rbi/lib/orb/models/customer_delete_params.rbi +20 -0
- data/rbi/lib/orb/models/customer_fetch_by_external_id_params.rbi +20 -0
- data/rbi/lib/orb/models/customer_fetch_params.rbi +20 -0
- data/rbi/lib/orb/models/customer_list_params.rbi +74 -0
- data/rbi/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +20 -0
- data/rbi/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rbi +20 -0
- data/rbi/lib/orb/models/customer_update_by_external_id_params.rbi +945 -0
- data/rbi/lib/orb/models/customer_update_params.rbi +919 -0
- data/rbi/lib/orb/models/customers/balance_transaction_create_params.rbi +64 -0
- data/rbi/lib/orb/models/customers/balance_transaction_create_response.rbi +199 -0
- data/rbi/lib/orb/models/customers/balance_transaction_list_params.rbi +76 -0
- data/rbi/lib/orb/models/customers/balance_transaction_list_response.rbi +191 -0
- data/rbi/lib/orb/models/customers/cost_list_by_external_id_params.rbi +86 -0
- data/rbi/lib/orb/models/customers/cost_list_by_external_id_response.rbi +214 -0
- data/rbi/lib/orb/models/customers/cost_list_params.rbi +84 -0
- data/rbi/lib/orb/models/customers/cost_list_response.rbi +212 -0
- data/rbi/lib/orb/models/customers/credit_list_by_external_id_params.rbi +64 -0
- data/rbi/lib/orb/models/customers/credit_list_by_external_id_response.rbi +87 -0
- data/rbi/lib/orb/models/customers/credit_list_params.rbi +64 -0
- data/rbi/lib/orb/models/customers/credit_list_response.rbi +86 -0
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +270 -0
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +1670 -0
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_params.rbi +238 -0
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_response.rbi +1626 -0
- data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +181 -0
- data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +1654 -0
- data/rbi/lib/orb/models/customers/credits/ledger_list_params.rbi +144 -0
- data/rbi/lib/orb/models/customers/credits/ledger_list_response.rbi +1588 -0
- data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +196 -0
- data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +198 -0
- data/rbi/lib/orb/models/customers/credits/top_up_create_params.rbi +176 -0
- data/rbi/lib/orb/models/customers/credits/top_up_create_response.rbi +175 -0
- data/rbi/lib/orb/models/customers/credits/top_up_delete_by_external_id_params.rbi +31 -0
- data/rbi/lib/orb/models/customers/credits/top_up_delete_params.rbi +28 -0
- data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rbi +49 -0
- data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +188 -0
- data/rbi/lib/orb/models/customers/credits/top_up_list_params.rbi +49 -0
- data/rbi/lib/orb/models/customers/credits/top_up_list_response.rbi +168 -0
- data/rbi/lib/orb/models/dimensional_price_group.rbi +75 -0
- data/rbi/lib/orb/models/dimensional_price_group_create_params.rbi +66 -0
- data/rbi/lib/orb/models/dimensional_price_group_list_params.rbi +39 -0
- data/rbi/lib/orb/models/dimensional_price_group_retrieve_params.rbi +20 -0
- data/rbi/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +22 -0
- data/rbi/lib/orb/models/dimensional_price_groups.rbi +35 -0
- data/rbi/lib/orb/models/discount.rbi +18 -0
- data/rbi/lib/orb/models/evaluate_price_group.rbi +45 -0
- data/rbi/lib/orb/models/event_deprecate_params.rbi +20 -0
- data/rbi/lib/orb/models/event_deprecate_response.rbi +19 -0
- data/rbi/lib/orb/models/event_ingest_params.rbi +120 -0
- data/rbi/lib/orb/models/event_ingest_response.rbi +79 -0
- data/rbi/lib/orb/models/event_search_params.rbi +53 -0
- data/rbi/lib/orb/models/event_search_response.rbi +100 -0
- data/rbi/lib/orb/models/event_update_params.rbi +71 -0
- data/rbi/lib/orb/models/event_update_response.rbi +19 -0
- data/rbi/lib/orb/models/events/backfill_close_params.rbi +22 -0
- data/rbi/lib/orb/models/events/backfill_close_response.rbi +127 -0
- data/rbi/lib/orb/models/events/backfill_create_params.rbi +97 -0
- data/rbi/lib/orb/models/events/backfill_create_response.rbi +128 -0
- data/rbi/lib/orb/models/events/backfill_fetch_params.rbi +22 -0
- data/rbi/lib/orb/models/events/backfill_fetch_response.rbi +127 -0
- data/rbi/lib/orb/models/events/backfill_list_params.rbi +41 -0
- data/rbi/lib/orb/models/events/backfill_list_response.rbi +127 -0
- data/rbi/lib/orb/models/events/backfill_revert_params.rbi +22 -0
- data/rbi/lib/orb/models/events/backfill_revert_response.rbi +128 -0
- data/rbi/lib/orb/models/events/event_volumes.rbi +47 -0
- data/rbi/lib/orb/models/events/volume_list_params.rbi +69 -0
- data/rbi/lib/orb/models/invoice.rbi +2466 -0
- data/rbi/lib/orb/models/invoice_create_params.rbi +230 -0
- data/rbi/lib/orb/models/invoice_fetch_params.rbi +20 -0
- data/rbi/lib/orb/models/invoice_fetch_upcoming_params.rbi +24 -0
- data/rbi/lib/orb/models/invoice_fetch_upcoming_response.rbi +2646 -0
- data/rbi/lib/orb/models/invoice_issue_params.rbi +32 -0
- data/rbi/lib/orb/models/invoice_level_discount.rbi +16 -0
- data/rbi/lib/orb/models/invoice_line_item_create_params.rbi +67 -0
- data/rbi/lib/orb/models/invoice_line_item_create_response.rbi +1164 -0
- data/rbi/lib/orb/models/invoice_list_params.rbi +187 -0
- data/rbi/lib/orb/models/invoice_mark_paid_params.rbi +48 -0
- data/rbi/lib/orb/models/invoice_pay_params.rbi +20 -0
- data/rbi/lib/orb/models/invoice_update_params.rbi +36 -0
- data/rbi/lib/orb/models/invoice_void_params.rbi +20 -0
- data/rbi/lib/orb/models/item.rbi +101 -0
- data/rbi/lib/orb/models/item_create_params.rbi +25 -0
- data/rbi/lib/orb/models/item_fetch_params.rbi +20 -0
- data/rbi/lib/orb/models/item_list_params.rbi +39 -0
- data/rbi/lib/orb/models/item_update_params.rbi +113 -0
- data/rbi/lib/orb/models/metric_create_params.rbi +62 -0
- data/rbi/lib/orb/models/metric_fetch_params.rbi +20 -0
- data/rbi/lib/orb/models/metric_list_params.rbi +74 -0
- data/rbi/lib/orb/models/metric_update_params.rbi +36 -0
- data/rbi/lib/orb/models/pagination_metadata.rbi +21 -0
- data/rbi/lib/orb/models/percentage_discount.rbi +63 -0
- data/rbi/lib/orb/models/plan.rbi +1071 -0
- data/rbi/lib/orb/models/plan_create_params.rbi +10069 -0
- data/rbi/lib/orb/models/plan_fetch_params.rbi +20 -0
- data/rbi/lib/orb/models/plan_list_params.rbi +100 -0
- data/rbi/lib/orb/models/plan_update_params.rbi +46 -0
- data/rbi/lib/orb/models/plans/external_plan_id_fetch_params.rbi +22 -0
- data/rbi/lib/orb/models/plans/external_plan_id_update_params.rbi +48 -0
- data/rbi/lib/orb/models/price.rbi +15341 -0
- data/rbi/lib/orb/models/price_create_params.rbi +885 -0
- data/rbi/lib/orb/models/price_evaluate_params.rbi +81 -0
- data/rbi/lib/orb/models/price_evaluate_response.rbi +21 -0
- data/rbi/lib/orb/models/price_fetch_params.rbi +20 -0
- data/rbi/lib/orb/models/price_list_params.rbi +39 -0
- data/rbi/lib/orb/models/price_update_params.rbi +36 -0
- data/rbi/lib/orb/models/prices/external_price_id_fetch_params.rbi +22 -0
- data/rbi/lib/orb/models/prices/external_price_id_update_params.rbi +38 -0
- data/rbi/lib/orb/models/subscription.rbi +1381 -0
- data/rbi/lib/orb/models/subscription_cancel_params.rbi +75 -0
- data/rbi/lib/orb/models/subscription_cancel_response.rbi +1374 -0
- data/rbi/lib/orb/models/subscription_create_params.rbi +23422 -0
- data/rbi/lib/orb/models/subscription_create_response.rbi +1374 -0
- data/rbi/lib/orb/models/subscription_fetch_costs_params.rbi +82 -0
- data/rbi/lib/orb/models/subscription_fetch_costs_response.rbi +210 -0
- data/rbi/lib/orb/models/subscription_fetch_params.rbi +20 -0
- data/rbi/lib/orb/models/subscription_fetch_schedule_params.rbi +74 -0
- data/rbi/lib/orb/models/subscription_fetch_schedule_response.rbi +81 -0
- data/rbi/lib/orb/models/subscription_fetch_usage_params.rbi +137 -0
- data/rbi/lib/orb/models/subscription_list_params.rbi +108 -0
- data/rbi/lib/orb/models/subscription_price_intervals_params.rbi +12991 -0
- data/rbi/lib/orb/models/subscription_price_intervals_response.rbi +1387 -0
- data/rbi/lib/orb/models/subscription_schedule_plan_change_params.rbi +23589 -0
- data/rbi/lib/orb/models/subscription_schedule_plan_change_response.rbi +1390 -0
- data/rbi/lib/orb/models/subscription_trigger_phase_params.rbi +45 -0
- data/rbi/lib/orb/models/subscription_trigger_phase_response.rbi +1381 -0
- data/rbi/lib/orb/models/subscription_unschedule_cancellation_params.rbi +20 -0
- data/rbi/lib/orb/models/subscription_unschedule_cancellation_response.rbi +1400 -0
- data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +25 -0
- data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +1451 -0
- data/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rbi +20 -0
- data/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +1410 -0
- data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_params.rbi +104 -0
- data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_response.rbi +1400 -0
- data/rbi/lib/orb/models/subscription_update_params.rbi +77 -0
- data/rbi/lib/orb/models/subscription_update_trial_params.rbi +63 -0
- data/rbi/lib/orb/models/subscription_update_trial_response.rbi +1378 -0
- data/rbi/lib/orb/models/subscription_usage.rbi +323 -0
- data/rbi/lib/orb/models/subscriptions.rbi +33 -0
- data/rbi/lib/orb/models/top_level_ping_params.rbi +20 -0
- data/rbi/lib/orb/models/top_level_ping_response.rbi +18 -0
- data/rbi/lib/orb/models/trial_discount.rbi +73 -0
- data/rbi/lib/orb/models/usage_discount.rbi +62 -0
- data/rbi/lib/orb/page.rbi +35 -0
- data/rbi/lib/orb/request_options.rbi +48 -0
- data/rbi/lib/orb/resources/alerts.rbi +216 -0
- data/rbi/lib/orb/resources/coupons/subscriptions.rbi +38 -0
- data/rbi/lib/orb/resources/coupons.rbi +96 -0
- data/rbi/lib/orb/resources/credit_notes.rbi +74 -0
- data/rbi/lib/orb/resources/customers/balance_transactions.rbi +92 -0
- data/rbi/lib/orb/resources/customers/costs.rbi +304 -0
- data/rbi/lib/orb/resources/customers/credits/ledger.rbi +645 -0
- data/rbi/lib/orb/resources/customers/credits/top_ups.rbi +180 -0
- data/rbi/lib/orb/resources/customers/credits.rbi +88 -0
- data/rbi/lib/orb/resources/customers.rbi +714 -0
- data/rbi/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi +25 -0
- data/rbi/lib/orb/resources/dimensional_price_groups.rbi +78 -0
- data/rbi/lib/orb/resources/events/backfills.rbi +161 -0
- data/rbi/lib/orb/resources/events/volume.rbi +57 -0
- data/rbi/lib/orb/resources/events.rbi +408 -0
- data/rbi/lib/orb/resources/invoice_line_items.rbi +44 -0
- data/rbi/lib/orb/resources/invoices.rbi +262 -0
- data/rbi/lib/orb/resources/items.rbi +65 -0
- data/rbi/lib/orb/resources/metrics.rbi +102 -0
- data/rbi/lib/orb/resources/plans/external_plan_id.rbi +67 -0
- data/rbi/lib/orb/resources/plans.rbi +170 -0
- data/rbi/lib/orb/resources/prices/external_price_id.rbi +110 -0
- data/rbi/lib/orb/resources/prices.rbi +371 -0
- data/rbi/lib/orb/resources/subscriptions.rbi +1469 -0
- data/rbi/lib/orb/resources/top_level.rbi +25 -0
- data/rbi/lib/orb/transport/base_client.rbi +205 -0
- data/rbi/lib/orb/transport/pooled_net_requester.rbi +64 -0
- data/rbi/lib/orb/type/array_of.rbi +82 -0
- data/rbi/lib/orb/type/base_model.rbi +197 -0
- data/rbi/lib/orb/type/base_page.rbi +38 -0
- data/rbi/lib/orb/type/boolean_model.rbi +41 -0
- data/rbi/lib/orb/type/converter.rbi +95 -0
- data/rbi/lib/orb/type/enum.rbi +58 -0
- data/rbi/lib/orb/type/hash_of.rbi +86 -0
- data/rbi/lib/orb/type/request_parameters.rbi +20 -0
- data/rbi/lib/orb/type/union.rbi +66 -0
- data/rbi/lib/orb/type/unknown.rbi +37 -0
- data/rbi/lib/orb/type.rbi +23 -0
- data/rbi/lib/orb/util.rbi +278 -0
- data/rbi/lib/orb/version.rbi +5 -0
- data/sig/orb/client.rbs +53 -0
- data/sig/orb/errors.rbs +201 -0
- data/sig/orb/models/alert.rbs +142 -0
- data/sig/orb/models/alert_create_for_customer_params.rbs +56 -0
- data/sig/orb/models/alert_create_for_external_customer_params.rbs +56 -0
- data/sig/orb/models/alert_create_for_subscription_params.rbs +52 -0
- data/sig/orb/models/alert_disable_params.rbs +20 -0
- data/sig/orb/models/alert_enable_params.rbs +20 -0
- data/sig/orb/models/alert_list_params.rbs +57 -0
- data/sig/orb/models/alert_retrieve_params.rbs +14 -0
- data/sig/orb/models/alert_update_params.rbs +31 -0
- data/sig/orb/models/amount_discount.rbs +40 -0
- data/sig/orb/models/billable_metric.rbs +50 -0
- data/sig/orb/models/billing_cycle_relative_date.rbs +14 -0
- data/sig/orb/models/coupon.rbs +51 -0
- data/sig/orb/models/coupon_archive_params.rbs +14 -0
- data/sig/orb/models/coupon_create_params.rbs +77 -0
- data/sig/orb/models/coupon_fetch_params.rbs +14 -0
- data/sig/orb/models/coupon_list_params.rbs +37 -0
- data/sig/orb/models/coupons/subscription_list_params.rbs +27 -0
- data/sig/orb/models/credit_note.rbs +345 -0
- data/sig/orb/models/credit_note_create_params.rbs +57 -0
- data/sig/orb/models/credit_note_fetch_params.rbs +14 -0
- data/sig/orb/models/credit_note_list_params.rbs +45 -0
- data/sig/orb/models/customer.rbs +628 -0
- data/sig/orb/models/customer_create_params.rbs +624 -0
- data/sig/orb/models/customer_delete_params.rbs +14 -0
- data/sig/orb/models/customer_fetch_by_external_id_params.rbs +14 -0
- data/sig/orb/models/customer_fetch_params.rbs +14 -0
- data/sig/orb/models/customer_list_params.rbs +45 -0
- data/sig/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbs +15 -0
- data/sig/orb/models/customer_sync_payment_methods_from_gateway_params.rbs +15 -0
- data/sig/orb/models/customer_update_by_external_id_params.rbs +620 -0
- data/sig/orb/models/customer_update_params.rbs +620 -0
- data/sig/orb/models/customers/balance_transaction_create_params.rbs +44 -0
- data/sig/orb/models/customers/balance_transaction_create_response.rbs +114 -0
- data/sig/orb/models/customers/balance_transaction_list_params.rbs +47 -0
- data/sig/orb/models/customers/balance_transaction_list_response.rbs +114 -0
- data/sig/orb/models/customers/cost_list_by_external_id_params.rbs +48 -0
- data/sig/orb/models/customers/cost_list_by_external_id_response.rbs +82 -0
- data/sig/orb/models/customers/cost_list_params.rbs +48 -0
- data/sig/orb/models/customers/cost_list_response.rbs +80 -0
- data/sig/orb/models/customers/credit_list_by_external_id_params.rbs +41 -0
- data/sig/orb/models/customers/credit_list_by_external_id_response.rbs +55 -0
- data/sig/orb/models/customers/credit_list_params.rbs +41 -0
- data/sig/orb/models/customers/credit_list_response.rbs +55 -0
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbs +120 -0
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +814 -0
- data/sig/orb/models/customers/credits/ledger_create_entry_params.rbs +120 -0
- data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +814 -0
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_params.rbs +99 -0
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +814 -0
- data/sig/orb/models/customers/credits/ledger_list_params.rbs +99 -0
- data/sig/orb/models/customers/credits/ledger_list_response.rbs +814 -0
- data/sig/orb/models/customers/credits/top_up_create_by_external_id_params.rbs +95 -0
- data/sig/orb/models/customers/credits/top_up_create_by_external_id_response.rbs +90 -0
- data/sig/orb/models/customers/credits/top_up_create_params.rbs +95 -0
- data/sig/orb/models/customers/credits/top_up_create_response.rbs +90 -0
- data/sig/orb/models/customers/credits/top_up_delete_by_external_id_params.rbs +24 -0
- data/sig/orb/models/customers/credits/top_up_delete_params.rbs +24 -0
- data/sig/orb/models/customers/credits/top_up_list_by_external_id_params.rbs +29 -0
- data/sig/orb/models/customers/credits/top_up_list_by_external_id_response.rbs +90 -0
- data/sig/orb/models/customers/credits/top_up_list_params.rbs +29 -0
- data/sig/orb/models/customers/credits/top_up_list_response.rbs +90 -0
- data/sig/orb/models/dimensional_price_group.rbs +38 -0
- data/sig/orb/models/dimensional_price_group_create_params.rbs +39 -0
- data/sig/orb/models/dimensional_price_group_list_params.rbs +25 -0
- data/sig/orb/models/dimensional_price_group_retrieve_params.rbs +15 -0
- data/sig/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbs +17 -0
- data/sig/orb/models/dimensional_price_groups.rbs +22 -0
- data/sig/orb/models/discount.rbs +15 -0
- data/sig/orb/models/evaluate_price_group.rbs +34 -0
- data/sig/orb/models/event_deprecate_params.rbs +14 -0
- data/sig/orb/models/event_deprecate_response.rbs +13 -0
- data/sig/orb/models/event_ingest_params.rbs +68 -0
- data/sig/orb/models/event_ingest_response.rbs +53 -0
- data/sig/orb/models/event_search_params.rbs +31 -0
- data/sig/orb/models/event_search_response.rbs +55 -0
- data/sig/orb/models/event_update_params.rbs +39 -0
- data/sig/orb/models/event_update_response.rbs +13 -0
- data/sig/orb/models/events/backfill_close_params.rbs +16 -0
- data/sig/orb/models/events/backfill_close_response.rbs +73 -0
- data/sig/orb/models/events/backfill_create_params.rbs +51 -0
- data/sig/orb/models/events/backfill_create_response.rbs +73 -0
- data/sig/orb/models/events/backfill_fetch_params.rbs +16 -0
- data/sig/orb/models/events/backfill_fetch_response.rbs +73 -0
- data/sig/orb/models/events/backfill_list_params.rbs +27 -0
- data/sig/orb/models/events/backfill_list_response.rbs +73 -0
- data/sig/orb/models/events/backfill_revert_params.rbs +16 -0
- data/sig/orb/models/events/backfill_revert_response.rbs +73 -0
- data/sig/orb/models/events/event_volumes.rbs +39 -0
- data/sig/orb/models/events/volume_list_params.rbs +41 -0
- data/sig/orb/models/invoice.rbs +1430 -0
- data/sig/orb/models/invoice_create_params.rbs +120 -0
- data/sig/orb/models/invoice_fetch_params.rbs +14 -0
- data/sig/orb/models/invoice_fetch_upcoming_params.rbs +20 -0
- data/sig/orb/models/invoice_fetch_upcoming_response.rbs +1430 -0
- data/sig/orb/models/invoice_issue_params.rbs +21 -0
- data/sig/orb/models/invoice_level_discount.rbs +14 -0
- data/sig/orb/models/invoice_line_item_create_params.rbs +43 -0
- data/sig/orb/models/invoice_line_item_create_response.rbs +546 -0
- data/sig/orb/models/invoice_list_params.rbs +122 -0
- data/sig/orb/models/invoice_mark_paid_params.rbs +27 -0
- data/sig/orb/models/invoice_pay_params.rbs +14 -0
- data/sig/orb/models/invoice_update_params.rbs +20 -0
- data/sig/orb/models/invoice_void_params.rbs +14 -0
- data/sig/orb/models/item.rbs +72 -0
- data/sig/orb/models/item_create_params.rbs +19 -0
- data/sig/orb/models/item_fetch_params.rbs +14 -0
- data/sig/orb/models/item_list_params.rbs +25 -0
- data/sig/orb/models/item_update_params.rbs +69 -0
- data/sig/orb/models/metric_create_params.rbs +39 -0
- data/sig/orb/models/metric_fetch_params.rbs +14 -0
- data/sig/orb/models/metric_list_params.rbs +45 -0
- data/sig/orb/models/metric_update_params.rbs +20 -0
- data/sig/orb/models/pagination_metadata.rbs +15 -0
- data/sig/orb/models/percentage_discount.rbs +40 -0
- data/sig/orb/models/plan.rbs +529 -0
- data/sig/orb/models/plan_create_params.rbs +3991 -0
- data/sig/orb/models/plan_fetch_params.rbs +14 -0
- data/sig/orb/models/plan_list_params.rbs +65 -0
- data/sig/orb/models/plan_update_params.rbs +24 -0
- data/sig/orb/models/plans/external_plan_id_fetch_params.rbs +16 -0
- data/sig/orb/models/plans/external_plan_id_update_params.rbs +26 -0
- data/sig/orb/models/price.rbs +8108 -0
- data/sig/orb/models/price_create_params.rbs +520 -0
- data/sig/orb/models/price_evaluate_params.rbs +45 -0
- data/sig/orb/models/price_evaluate_response.rbs +14 -0
- data/sig/orb/models/price_fetch_params.rbs +14 -0
- data/sig/orb/models/price_list_params.rbs +25 -0
- data/sig/orb/models/price_update_params.rbs +20 -0
- data/sig/orb/models/prices/external_price_id_fetch_params.rbs +16 -0
- data/sig/orb/models/prices/external_price_id_update_params.rbs +22 -0
- data/sig/orb/models/subscription.rbs +687 -0
- data/sig/orb/models/subscription_cancel_params.rbs +44 -0
- data/sig/orb/models/subscription_cancel_response.rbs +687 -0
- data/sig/orb/models/subscription_create_params.rbs +9141 -0
- data/sig/orb/models/subscription_create_response.rbs +687 -0
- data/sig/orb/models/subscription_fetch_costs_params.rbs +46 -0
- data/sig/orb/models/subscription_fetch_costs_response.rbs +78 -0
- data/sig/orb/models/subscription_fetch_params.rbs +14 -0
- data/sig/orb/models/subscription_fetch_schedule_params.rbs +45 -0
- data/sig/orb/models/subscription_fetch_schedule_response.rbs +48 -0
- data/sig/orb/models/subscription_fetch_usage_params.rbs +80 -0
- data/sig/orb/models/subscription_list_params.rbs +69 -0
- data/sig/orb/models/subscription_price_intervals_params.rbs +5117 -0
- data/sig/orb/models/subscription_price_intervals_response.rbs +687 -0
- data/sig/orb/models/subscription_schedule_plan_change_params.rbs +9133 -0
- data/sig/orb/models/subscription_schedule_plan_change_response.rbs +687 -0
- data/sig/orb/models/subscription_trigger_phase_params.rbs +24 -0
- data/sig/orb/models/subscription_trigger_phase_response.rbs +687 -0
- data/sig/orb/models/subscription_unschedule_cancellation_params.rbs +15 -0
- data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +687 -0
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbs +20 -0
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +687 -0
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_params.rbs +15 -0
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +687 -0
- data/sig/orb/models/subscription_update_fixed_fee_quantity_params.rbs +55 -0
- data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +687 -0
- data/sig/orb/models/subscription_update_params.rbs +39 -0
- data/sig/orb/models/subscription_update_trial_params.rbs +39 -0
- data/sig/orb/models/subscription_update_trial_response.rbs +687 -0
- data/sig/orb/models/subscription_usage.rbs +196 -0
- data/sig/orb/models/subscriptions.rbs +22 -0
- data/sig/orb/models/top_level_ping_params.rbs +14 -0
- data/sig/orb/models/top_level_ping_response.rbs +13 -0
- data/sig/orb/models/trial_discount.rbs +44 -0
- data/sig/orb/models/usage_discount.rbs +40 -0
- data/sig/orb/page.rbs +22 -0
- data/sig/orb/request_options.rbs +32 -0
- data/sig/orb/resources/alerts.rbs +67 -0
- data/sig/orb/resources/coupons/subscriptions.rbs +16 -0
- data/sig/orb/resources/coupons.rbs +35 -0
- data/sig/orb/resources/credit_notes.rbs +29 -0
- data/sig/orb/resources/customers/balance_transactions.rbs +28 -0
- data/sig/orb/resources/customers/costs.rbs +27 -0
- data/sig/orb/resources/customers/credits/ledger.rbs +75 -0
- data/sig/orb/resources/customers/credits/top_ups.rbs +63 -0
- data/sig/orb/resources/customers/credits.rbs +31 -0
- data/sig/orb/resources/customers.rbs +114 -0
- data/sig/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbs +14 -0
- data/sig/orb/resources/dimensional_price_groups.rbs +29 -0
- data/sig/orb/resources/events/backfills.rbs +41 -0
- data/sig/orb/resources/events/volume.rbs +17 -0
- data/sig/orb/resources/events.rbs +40 -0
- data/sig/orb/resources/invoice_line_items.rbs +17 -0
- data/sig/orb/resources/invoices.rbs +84 -0
- data/sig/orb/resources/items.rbs +30 -0
- data/sig/orb/resources/metrics.rbs +37 -0
- data/sig/orb/resources/plans/external_plan_id.rbs +21 -0
- data/sig/orb/resources/plans.rbs +44 -0
- data/sig/orb/resources/prices/external_price_id.rbs +20 -0
- data/sig/orb/resources/prices.rbs +83 -0
- data/sig/orb/resources/subscriptions.rbs +194 -0
- data/sig/orb/resources/top_level.rbs +11 -0
- data/sig/orb/transport/base_client.rbs +110 -0
- data/sig/orb/transport/pooled_net_requester.rbs +39 -0
- data/sig/orb/type/array_of.rbs +36 -0
- data/sig/orb/type/base_model.rbs +77 -0
- data/sig/orb/type/base_page.rbs +22 -0
- data/sig/orb/type/boolean_model.rbs +18 -0
- data/sig/orb/type/converter.rbs +36 -0
- data/sig/orb/type/enum.rbs +22 -0
- data/sig/orb/type/hash_of.rbs +36 -0
- data/sig/orb/type/request_parameters.rbs +13 -0
- data/sig/orb/type/union.rbs +37 -0
- data/sig/orb/type/unknown.rbs +15 -0
- data/sig/orb/type.rbs +22 -0
- data/sig/orb/util.rbs +132 -0
- data/sig/orb/version.rbs +3 -0
- metadata +692 -0
@@ -0,0 +1,929 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Orb
|
4
|
+
module Models
|
5
|
+
# @see Orb::Resources::InvoiceLineItems#create
|
6
|
+
class InvoiceLineItemCreateResponse < Orb::BaseModel
|
7
|
+
# @!attribute id
|
8
|
+
# A unique ID for this line item.
|
9
|
+
#
|
10
|
+
# @return [String]
|
11
|
+
required :id, String
|
12
|
+
|
13
|
+
# @!attribute adjusted_subtotal
|
14
|
+
# The line amount after any adjustments and before overage conversion, credits and
|
15
|
+
# partial invoicing.
|
16
|
+
#
|
17
|
+
# @return [String]
|
18
|
+
required :adjusted_subtotal, String
|
19
|
+
|
20
|
+
# @!attribute adjustments
|
21
|
+
# All adjustments applied to the line item in the order they were applied based on
|
22
|
+
# invoice calculations (ie. usage discounts -> amount discounts -> percentage
|
23
|
+
# discounts -> minimums -> maximums).
|
24
|
+
#
|
25
|
+
# @return [Array<Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryUsageDiscountAdjustment, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryAmountDiscountAdjustment, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryPercentageDiscountAdjustment, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryMinimumAdjustment, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryMaximumAdjustment>]
|
26
|
+
required :adjustments, -> { Orb::ArrayOf[union: Orb::Models::InvoiceLineItemCreateResponse::Adjustment] }
|
27
|
+
|
28
|
+
# @!attribute amount
|
29
|
+
# The final amount for a line item after all adjustments and pre paid credits have
|
30
|
+
# been applied.
|
31
|
+
#
|
32
|
+
# @return [String]
|
33
|
+
required :amount, String
|
34
|
+
|
35
|
+
# @!attribute credits_applied
|
36
|
+
# The number of prepaid credits applied.
|
37
|
+
#
|
38
|
+
# @return [String]
|
39
|
+
required :credits_applied, String
|
40
|
+
|
41
|
+
# @!attribute discount
|
42
|
+
#
|
43
|
+
# @return [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil]
|
44
|
+
required :discount, union: -> { Orb::Models::Discount }, nil?: true
|
45
|
+
|
46
|
+
# @!attribute end_date
|
47
|
+
# The end date of the range of time applied for this line item's price.
|
48
|
+
#
|
49
|
+
# @return [Time]
|
50
|
+
required :end_date, Time
|
51
|
+
|
52
|
+
# @!attribute filter
|
53
|
+
# An additional filter that was used to calculate the usage for this line item.
|
54
|
+
#
|
55
|
+
# @return [String, nil]
|
56
|
+
required :filter, String, nil?: true
|
57
|
+
|
58
|
+
# @!attribute grouping
|
59
|
+
# [DEPRECATED] For configured prices that are split by a grouping key, this will
|
60
|
+
# be populated with the key and a value. The `amount` and `subtotal` will be the
|
61
|
+
# values for this particular grouping.
|
62
|
+
#
|
63
|
+
# @return [String, nil]
|
64
|
+
required :grouping, String, nil?: true
|
65
|
+
|
66
|
+
# @!attribute maximum
|
67
|
+
# This field is deprecated in favor of `adjustments`.
|
68
|
+
#
|
69
|
+
# @return [Orb::Models::InvoiceLineItemCreateResponse::Maximum, nil]
|
70
|
+
required :maximum, -> { Orb::Models::InvoiceLineItemCreateResponse::Maximum }, nil?: true
|
71
|
+
|
72
|
+
# @!attribute maximum_amount
|
73
|
+
# This field is deprecated in favor of `adjustments`.
|
74
|
+
#
|
75
|
+
# @return [String, nil]
|
76
|
+
required :maximum_amount, String, nil?: true
|
77
|
+
|
78
|
+
# @!attribute minimum
|
79
|
+
# This field is deprecated in favor of `adjustments`.
|
80
|
+
#
|
81
|
+
# @return [Orb::Models::InvoiceLineItemCreateResponse::Minimum, nil]
|
82
|
+
required :minimum, -> { Orb::Models::InvoiceLineItemCreateResponse::Minimum }, nil?: true
|
83
|
+
|
84
|
+
# @!attribute minimum_amount
|
85
|
+
# This field is deprecated in favor of `adjustments`.
|
86
|
+
#
|
87
|
+
# @return [String, nil]
|
88
|
+
required :minimum_amount, String, nil?: true
|
89
|
+
|
90
|
+
# @!attribute name
|
91
|
+
# The name of the price associated with this line item.
|
92
|
+
#
|
93
|
+
# @return [String]
|
94
|
+
required :name, String
|
95
|
+
|
96
|
+
# @!attribute partially_invoiced_amount
|
97
|
+
# Any amount applied from a partial invoice
|
98
|
+
#
|
99
|
+
# @return [String]
|
100
|
+
required :partially_invoiced_amount, String
|
101
|
+
|
102
|
+
# @!attribute price
|
103
|
+
# The Price resource represents a price that can be billed on a subscription,
|
104
|
+
# resulting in a charge on an invoice in the form of an invoice line item. Prices
|
105
|
+
# take a quantity and determine an amount to bill.
|
106
|
+
#
|
107
|
+
# Orb supports a few different pricing models out of the box. Each of these models
|
108
|
+
# is serialized differently in a given Price object. The model_type field
|
109
|
+
# determines the key for the configuration object that is present.
|
110
|
+
#
|
111
|
+
# For more on the types of prices, see
|
112
|
+
# [the core concepts documentation](/core-concepts#plan-and-price)
|
113
|
+
#
|
114
|
+
# @return [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice, nil]
|
115
|
+
required :price, union: -> { Orb::Models::Price }, nil?: true
|
116
|
+
|
117
|
+
# @!attribute quantity
|
118
|
+
# Either the fixed fee quantity or the usage during the service period.
|
119
|
+
#
|
120
|
+
# @return [Float]
|
121
|
+
required :quantity, Float
|
122
|
+
|
123
|
+
# @!attribute start_date
|
124
|
+
# The start date of the range of time applied for this line item's price.
|
125
|
+
#
|
126
|
+
# @return [Time]
|
127
|
+
required :start_date, Time
|
128
|
+
|
129
|
+
# @!attribute sub_line_items
|
130
|
+
# For complex pricing structures, the line item can be broken down further in
|
131
|
+
# `sub_line_items`.
|
132
|
+
#
|
133
|
+
# @return [Array<Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::MatrixSubLineItem, Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::TierSubLineItem, Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::OtherSubLineItem>]
|
134
|
+
required :sub_line_items,
|
135
|
+
-> { Orb::ArrayOf[union: Orb::Models::InvoiceLineItemCreateResponse::SubLineItem] }
|
136
|
+
|
137
|
+
# @!attribute subtotal
|
138
|
+
# The line amount before before any adjustments.
|
139
|
+
#
|
140
|
+
# @return [String]
|
141
|
+
required :subtotal, String
|
142
|
+
|
143
|
+
# @!attribute tax_amounts
|
144
|
+
# An array of tax rates and their incurred tax amounts. Empty if no tax
|
145
|
+
# integration is configured.
|
146
|
+
#
|
147
|
+
# @return [Array<Orb::Models::InvoiceLineItemCreateResponse::TaxAmount>]
|
148
|
+
required :tax_amounts, -> { Orb::ArrayOf[Orb::Models::InvoiceLineItemCreateResponse::TaxAmount] }
|
149
|
+
|
150
|
+
# @!attribute usage_customer_ids
|
151
|
+
# A list of customer ids that were used to calculate the usage for this line item.
|
152
|
+
#
|
153
|
+
# @return [Array<String>, nil]
|
154
|
+
required :usage_customer_ids, Orb::ArrayOf[String], nil?: true
|
155
|
+
|
156
|
+
# @!parse
|
157
|
+
# # @param id [String]
|
158
|
+
# # @param adjusted_subtotal [String]
|
159
|
+
# # @param adjustments [Array<Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryUsageDiscountAdjustment, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryAmountDiscountAdjustment, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryPercentageDiscountAdjustment, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryMinimumAdjustment, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryMaximumAdjustment>]
|
160
|
+
# # @param amount [String]
|
161
|
+
# # @param credits_applied [String]
|
162
|
+
# # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil]
|
163
|
+
# # @param end_date [Time]
|
164
|
+
# # @param filter [String, nil]
|
165
|
+
# # @param grouping [String, nil]
|
166
|
+
# # @param maximum [Orb::Models::InvoiceLineItemCreateResponse::Maximum, nil]
|
167
|
+
# # @param maximum_amount [String, nil]
|
168
|
+
# # @param minimum [Orb::Models::InvoiceLineItemCreateResponse::Minimum, nil]
|
169
|
+
# # @param minimum_amount [String, nil]
|
170
|
+
# # @param name [String]
|
171
|
+
# # @param partially_invoiced_amount [String]
|
172
|
+
# # @param price [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice, nil]
|
173
|
+
# # @param quantity [Float]
|
174
|
+
# # @param start_date [Time]
|
175
|
+
# # @param sub_line_items [Array<Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::MatrixSubLineItem, Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::TierSubLineItem, Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::OtherSubLineItem>]
|
176
|
+
# # @param subtotal [String]
|
177
|
+
# # @param tax_amounts [Array<Orb::Models::InvoiceLineItemCreateResponse::TaxAmount>]
|
178
|
+
# # @param usage_customer_ids [Array<String>, nil]
|
179
|
+
# #
|
180
|
+
# def initialize(
|
181
|
+
# id:,
|
182
|
+
# adjusted_subtotal:,
|
183
|
+
# adjustments:,
|
184
|
+
# amount:,
|
185
|
+
# credits_applied:,
|
186
|
+
# discount:,
|
187
|
+
# end_date:,
|
188
|
+
# filter:,
|
189
|
+
# grouping:,
|
190
|
+
# maximum:,
|
191
|
+
# maximum_amount:,
|
192
|
+
# minimum:,
|
193
|
+
# minimum_amount:,
|
194
|
+
# name:,
|
195
|
+
# partially_invoiced_amount:,
|
196
|
+
# price:,
|
197
|
+
# quantity:,
|
198
|
+
# start_date:,
|
199
|
+
# sub_line_items:,
|
200
|
+
# subtotal:,
|
201
|
+
# tax_amounts:,
|
202
|
+
# usage_customer_ids:,
|
203
|
+
# **
|
204
|
+
# )
|
205
|
+
# super
|
206
|
+
# end
|
207
|
+
|
208
|
+
# def initialize: (Hash | Orb::BaseModel) -> void
|
209
|
+
|
210
|
+
module Adjustment
|
211
|
+
extend Orb::Union
|
212
|
+
|
213
|
+
discriminator :adjustment_type
|
214
|
+
|
215
|
+
variant :usage_discount,
|
216
|
+
-> { Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryUsageDiscountAdjustment }
|
217
|
+
|
218
|
+
variant :amount_discount,
|
219
|
+
-> { Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryAmountDiscountAdjustment }
|
220
|
+
|
221
|
+
variant :percentage_discount,
|
222
|
+
-> { Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryPercentageDiscountAdjustment }
|
223
|
+
|
224
|
+
variant :minimum, -> { Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryMinimumAdjustment }
|
225
|
+
|
226
|
+
variant :maximum, -> { Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryMaximumAdjustment }
|
227
|
+
|
228
|
+
class MonetaryUsageDiscountAdjustment < Orb::BaseModel
|
229
|
+
# @!attribute id
|
230
|
+
#
|
231
|
+
# @return [String]
|
232
|
+
required :id, String
|
233
|
+
|
234
|
+
# @!attribute adjustment_type
|
235
|
+
#
|
236
|
+
# @return [Symbol, :usage_discount]
|
237
|
+
required :adjustment_type, const: :usage_discount
|
238
|
+
|
239
|
+
# @!attribute amount
|
240
|
+
# The value applied by an adjustment.
|
241
|
+
#
|
242
|
+
# @return [String]
|
243
|
+
required :amount, String
|
244
|
+
|
245
|
+
# @!attribute applies_to_price_ids
|
246
|
+
# The price IDs that this adjustment applies to.
|
247
|
+
#
|
248
|
+
# @return [Array<String>]
|
249
|
+
required :applies_to_price_ids, Orb::ArrayOf[String]
|
250
|
+
|
251
|
+
# @!attribute is_invoice_level
|
252
|
+
# True for adjustments that apply to an entire invocice, false for adjustments
|
253
|
+
# that apply to only one price.
|
254
|
+
#
|
255
|
+
# @return [Boolean]
|
256
|
+
required :is_invoice_level, Orb::BooleanModel
|
257
|
+
|
258
|
+
# @!attribute reason
|
259
|
+
# The reason for the adjustment.
|
260
|
+
#
|
261
|
+
# @return [String, nil]
|
262
|
+
required :reason, String, nil?: true
|
263
|
+
|
264
|
+
# @!attribute usage_discount
|
265
|
+
# The number of usage units by which to discount the price this adjustment applies
|
266
|
+
# to in a given billing period.
|
267
|
+
#
|
268
|
+
# @return [Float]
|
269
|
+
required :usage_discount, Float
|
270
|
+
|
271
|
+
# @!parse
|
272
|
+
# # @param id [String]
|
273
|
+
# # @param amount [String]
|
274
|
+
# # @param applies_to_price_ids [Array<String>]
|
275
|
+
# # @param is_invoice_level [Boolean]
|
276
|
+
# # @param reason [String, nil]
|
277
|
+
# # @param usage_discount [Float]
|
278
|
+
# # @param adjustment_type [Symbol, :usage_discount]
|
279
|
+
# #
|
280
|
+
# def initialize(
|
281
|
+
# id:,
|
282
|
+
# amount:,
|
283
|
+
# applies_to_price_ids:,
|
284
|
+
# is_invoice_level:,
|
285
|
+
# reason:,
|
286
|
+
# usage_discount:,
|
287
|
+
# adjustment_type: :usage_discount,
|
288
|
+
# **
|
289
|
+
# )
|
290
|
+
# super
|
291
|
+
# end
|
292
|
+
|
293
|
+
# def initialize: (Hash | Orb::BaseModel) -> void
|
294
|
+
end
|
295
|
+
|
296
|
+
class MonetaryAmountDiscountAdjustment < Orb::BaseModel
|
297
|
+
# @!attribute id
|
298
|
+
#
|
299
|
+
# @return [String]
|
300
|
+
required :id, String
|
301
|
+
|
302
|
+
# @!attribute adjustment_type
|
303
|
+
#
|
304
|
+
# @return [Symbol, :amount_discount]
|
305
|
+
required :adjustment_type, const: :amount_discount
|
306
|
+
|
307
|
+
# @!attribute amount
|
308
|
+
# The value applied by an adjustment.
|
309
|
+
#
|
310
|
+
# @return [String]
|
311
|
+
required :amount, String
|
312
|
+
|
313
|
+
# @!attribute amount_discount
|
314
|
+
# The amount by which to discount the prices this adjustment applies to in a given
|
315
|
+
# billing period.
|
316
|
+
#
|
317
|
+
# @return [String]
|
318
|
+
required :amount_discount, String
|
319
|
+
|
320
|
+
# @!attribute applies_to_price_ids
|
321
|
+
# The price IDs that this adjustment applies to.
|
322
|
+
#
|
323
|
+
# @return [Array<String>]
|
324
|
+
required :applies_to_price_ids, Orb::ArrayOf[String]
|
325
|
+
|
326
|
+
# @!attribute is_invoice_level
|
327
|
+
# True for adjustments that apply to an entire invocice, false for adjustments
|
328
|
+
# that apply to only one price.
|
329
|
+
#
|
330
|
+
# @return [Boolean]
|
331
|
+
required :is_invoice_level, Orb::BooleanModel
|
332
|
+
|
333
|
+
# @!attribute reason
|
334
|
+
# The reason for the adjustment.
|
335
|
+
#
|
336
|
+
# @return [String, nil]
|
337
|
+
required :reason, String, nil?: true
|
338
|
+
|
339
|
+
# @!parse
|
340
|
+
# # @param id [String]
|
341
|
+
# # @param amount [String]
|
342
|
+
# # @param amount_discount [String]
|
343
|
+
# # @param applies_to_price_ids [Array<String>]
|
344
|
+
# # @param is_invoice_level [Boolean]
|
345
|
+
# # @param reason [String, nil]
|
346
|
+
# # @param adjustment_type [Symbol, :amount_discount]
|
347
|
+
# #
|
348
|
+
# def initialize(
|
349
|
+
# id:,
|
350
|
+
# amount:,
|
351
|
+
# amount_discount:,
|
352
|
+
# applies_to_price_ids:,
|
353
|
+
# is_invoice_level:,
|
354
|
+
# reason:,
|
355
|
+
# adjustment_type: :amount_discount,
|
356
|
+
# **
|
357
|
+
# )
|
358
|
+
# super
|
359
|
+
# end
|
360
|
+
|
361
|
+
# def initialize: (Hash | Orb::BaseModel) -> void
|
362
|
+
end
|
363
|
+
|
364
|
+
class MonetaryPercentageDiscountAdjustment < Orb::BaseModel
|
365
|
+
# @!attribute id
|
366
|
+
#
|
367
|
+
# @return [String]
|
368
|
+
required :id, String
|
369
|
+
|
370
|
+
# @!attribute adjustment_type
|
371
|
+
#
|
372
|
+
# @return [Symbol, :percentage_discount]
|
373
|
+
required :adjustment_type, const: :percentage_discount
|
374
|
+
|
375
|
+
# @!attribute amount
|
376
|
+
# The value applied by an adjustment.
|
377
|
+
#
|
378
|
+
# @return [String]
|
379
|
+
required :amount, String
|
380
|
+
|
381
|
+
# @!attribute applies_to_price_ids
|
382
|
+
# The price IDs that this adjustment applies to.
|
383
|
+
#
|
384
|
+
# @return [Array<String>]
|
385
|
+
required :applies_to_price_ids, Orb::ArrayOf[String]
|
386
|
+
|
387
|
+
# @!attribute is_invoice_level
|
388
|
+
# True for adjustments that apply to an entire invocice, false for adjustments
|
389
|
+
# that apply to only one price.
|
390
|
+
#
|
391
|
+
# @return [Boolean]
|
392
|
+
required :is_invoice_level, Orb::BooleanModel
|
393
|
+
|
394
|
+
# @!attribute percentage_discount
|
395
|
+
# The percentage (as a value between 0 and 1) by which to discount the price
|
396
|
+
# intervals this adjustment applies to in a given billing period.
|
397
|
+
#
|
398
|
+
# @return [Float]
|
399
|
+
required :percentage_discount, Float
|
400
|
+
|
401
|
+
# @!attribute reason
|
402
|
+
# The reason for the adjustment.
|
403
|
+
#
|
404
|
+
# @return [String, nil]
|
405
|
+
required :reason, String, nil?: true
|
406
|
+
|
407
|
+
# @!parse
|
408
|
+
# # @param id [String]
|
409
|
+
# # @param amount [String]
|
410
|
+
# # @param applies_to_price_ids [Array<String>]
|
411
|
+
# # @param is_invoice_level [Boolean]
|
412
|
+
# # @param percentage_discount [Float]
|
413
|
+
# # @param reason [String, nil]
|
414
|
+
# # @param adjustment_type [Symbol, :percentage_discount]
|
415
|
+
# #
|
416
|
+
# def initialize(
|
417
|
+
# id:,
|
418
|
+
# amount:,
|
419
|
+
# applies_to_price_ids:,
|
420
|
+
# is_invoice_level:,
|
421
|
+
# percentage_discount:,
|
422
|
+
# reason:,
|
423
|
+
# adjustment_type: :percentage_discount,
|
424
|
+
# **
|
425
|
+
# )
|
426
|
+
# super
|
427
|
+
# end
|
428
|
+
|
429
|
+
# def initialize: (Hash | Orb::BaseModel) -> void
|
430
|
+
end
|
431
|
+
|
432
|
+
class MonetaryMinimumAdjustment < Orb::BaseModel
|
433
|
+
# @!attribute id
|
434
|
+
#
|
435
|
+
# @return [String]
|
436
|
+
required :id, String
|
437
|
+
|
438
|
+
# @!attribute adjustment_type
|
439
|
+
#
|
440
|
+
# @return [Symbol, :minimum]
|
441
|
+
required :adjustment_type, const: :minimum
|
442
|
+
|
443
|
+
# @!attribute amount
|
444
|
+
# The value applied by an adjustment.
|
445
|
+
#
|
446
|
+
# @return [String]
|
447
|
+
required :amount, String
|
448
|
+
|
449
|
+
# @!attribute applies_to_price_ids
|
450
|
+
# The price IDs that this adjustment applies to.
|
451
|
+
#
|
452
|
+
# @return [Array<String>]
|
453
|
+
required :applies_to_price_ids, Orb::ArrayOf[String]
|
454
|
+
|
455
|
+
# @!attribute is_invoice_level
|
456
|
+
# True for adjustments that apply to an entire invocice, false for adjustments
|
457
|
+
# that apply to only one price.
|
458
|
+
#
|
459
|
+
# @return [Boolean]
|
460
|
+
required :is_invoice_level, Orb::BooleanModel
|
461
|
+
|
462
|
+
# @!attribute item_id
|
463
|
+
# The item ID that revenue from this minimum will be attributed to.
|
464
|
+
#
|
465
|
+
# @return [String]
|
466
|
+
required :item_id, String
|
467
|
+
|
468
|
+
# @!attribute minimum_amount
|
469
|
+
# The minimum amount to charge in a given billing period for the prices this
|
470
|
+
# adjustment applies to.
|
471
|
+
#
|
472
|
+
# @return [String]
|
473
|
+
required :minimum_amount, String
|
474
|
+
|
475
|
+
# @!attribute reason
|
476
|
+
# The reason for the adjustment.
|
477
|
+
#
|
478
|
+
# @return [String, nil]
|
479
|
+
required :reason, String, nil?: true
|
480
|
+
|
481
|
+
# @!parse
|
482
|
+
# # @param id [String]
|
483
|
+
# # @param amount [String]
|
484
|
+
# # @param applies_to_price_ids [Array<String>]
|
485
|
+
# # @param is_invoice_level [Boolean]
|
486
|
+
# # @param item_id [String]
|
487
|
+
# # @param minimum_amount [String]
|
488
|
+
# # @param reason [String, nil]
|
489
|
+
# # @param adjustment_type [Symbol, :minimum]
|
490
|
+
# #
|
491
|
+
# def initialize(
|
492
|
+
# id:,
|
493
|
+
# amount:,
|
494
|
+
# applies_to_price_ids:,
|
495
|
+
# is_invoice_level:,
|
496
|
+
# item_id:,
|
497
|
+
# minimum_amount:,
|
498
|
+
# reason:,
|
499
|
+
# adjustment_type: :minimum,
|
500
|
+
# **
|
501
|
+
# )
|
502
|
+
# super
|
503
|
+
# end
|
504
|
+
|
505
|
+
# def initialize: (Hash | Orb::BaseModel) -> void
|
506
|
+
end
|
507
|
+
|
508
|
+
class MonetaryMaximumAdjustment < Orb::BaseModel
|
509
|
+
# @!attribute id
|
510
|
+
#
|
511
|
+
# @return [String]
|
512
|
+
required :id, String
|
513
|
+
|
514
|
+
# @!attribute adjustment_type
|
515
|
+
#
|
516
|
+
# @return [Symbol, :maximum]
|
517
|
+
required :adjustment_type, const: :maximum
|
518
|
+
|
519
|
+
# @!attribute amount
|
520
|
+
# The value applied by an adjustment.
|
521
|
+
#
|
522
|
+
# @return [String]
|
523
|
+
required :amount, String
|
524
|
+
|
525
|
+
# @!attribute applies_to_price_ids
|
526
|
+
# The price IDs that this adjustment applies to.
|
527
|
+
#
|
528
|
+
# @return [Array<String>]
|
529
|
+
required :applies_to_price_ids, Orb::ArrayOf[String]
|
530
|
+
|
531
|
+
# @!attribute is_invoice_level
|
532
|
+
# True for adjustments that apply to an entire invocice, false for adjustments
|
533
|
+
# that apply to only one price.
|
534
|
+
#
|
535
|
+
# @return [Boolean]
|
536
|
+
required :is_invoice_level, Orb::BooleanModel
|
537
|
+
|
538
|
+
# @!attribute maximum_amount
|
539
|
+
# The maximum amount to charge in a given billing period for the prices this
|
540
|
+
# adjustment applies to.
|
541
|
+
#
|
542
|
+
# @return [String]
|
543
|
+
required :maximum_amount, String
|
544
|
+
|
545
|
+
# @!attribute reason
|
546
|
+
# The reason for the adjustment.
|
547
|
+
#
|
548
|
+
# @return [String, nil]
|
549
|
+
required :reason, String, nil?: true
|
550
|
+
|
551
|
+
# @!parse
|
552
|
+
# # @param id [String]
|
553
|
+
# # @param amount [String]
|
554
|
+
# # @param applies_to_price_ids [Array<String>]
|
555
|
+
# # @param is_invoice_level [Boolean]
|
556
|
+
# # @param maximum_amount [String]
|
557
|
+
# # @param reason [String, nil]
|
558
|
+
# # @param adjustment_type [Symbol, :maximum]
|
559
|
+
# #
|
560
|
+
# def initialize(
|
561
|
+
# id:,
|
562
|
+
# amount:,
|
563
|
+
# applies_to_price_ids:,
|
564
|
+
# is_invoice_level:,
|
565
|
+
# maximum_amount:,
|
566
|
+
# reason:,
|
567
|
+
# adjustment_type: :maximum,
|
568
|
+
# **
|
569
|
+
# )
|
570
|
+
# super
|
571
|
+
# end
|
572
|
+
|
573
|
+
# def initialize: (Hash | Orb::BaseModel) -> void
|
574
|
+
end
|
575
|
+
|
576
|
+
# @!parse
|
577
|
+
# # @return [Array(Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryUsageDiscountAdjustment, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryAmountDiscountAdjustment, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryPercentageDiscountAdjustment, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryMinimumAdjustment, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryMaximumAdjustment)]
|
578
|
+
# def self.variants; end
|
579
|
+
end
|
580
|
+
|
581
|
+
# @deprecated
|
582
|
+
#
|
583
|
+
# @see Orb::Models::InvoiceLineItemCreateResponse#maximum
|
584
|
+
class Maximum < Orb::BaseModel
|
585
|
+
# @!attribute applies_to_price_ids
|
586
|
+
# List of price_ids that this maximum amount applies to. For plan/plan phase
|
587
|
+
# maximums, this can be a subset of prices.
|
588
|
+
#
|
589
|
+
# @return [Array<String>]
|
590
|
+
required :applies_to_price_ids, Orb::ArrayOf[String]
|
591
|
+
|
592
|
+
# @!attribute maximum_amount
|
593
|
+
# Maximum amount applied
|
594
|
+
#
|
595
|
+
# @return [String]
|
596
|
+
required :maximum_amount, String
|
597
|
+
|
598
|
+
# @!parse
|
599
|
+
# # This field is deprecated in favor of `adjustments`.
|
600
|
+
# #
|
601
|
+
# # @param applies_to_price_ids [Array<String>]
|
602
|
+
# # @param maximum_amount [String]
|
603
|
+
# #
|
604
|
+
# def initialize(applies_to_price_ids:, maximum_amount:, **) = super
|
605
|
+
|
606
|
+
# def initialize: (Hash | Orb::BaseModel) -> void
|
607
|
+
end
|
608
|
+
|
609
|
+
# @deprecated
|
610
|
+
#
|
611
|
+
# @see Orb::Models::InvoiceLineItemCreateResponse#minimum
|
612
|
+
class Minimum < Orb::BaseModel
|
613
|
+
# @!attribute applies_to_price_ids
|
614
|
+
# List of price_ids that this minimum amount applies to. For plan/plan phase
|
615
|
+
# minimums, this can be a subset of prices.
|
616
|
+
#
|
617
|
+
# @return [Array<String>]
|
618
|
+
required :applies_to_price_ids, Orb::ArrayOf[String]
|
619
|
+
|
620
|
+
# @!attribute minimum_amount
|
621
|
+
# Minimum amount applied
|
622
|
+
#
|
623
|
+
# @return [String]
|
624
|
+
required :minimum_amount, String
|
625
|
+
|
626
|
+
# @!parse
|
627
|
+
# # This field is deprecated in favor of `adjustments`.
|
628
|
+
# #
|
629
|
+
# # @param applies_to_price_ids [Array<String>]
|
630
|
+
# # @param minimum_amount [String]
|
631
|
+
# #
|
632
|
+
# def initialize(applies_to_price_ids:, minimum_amount:, **) = super
|
633
|
+
|
634
|
+
# def initialize: (Hash | Orb::BaseModel) -> void
|
635
|
+
end
|
636
|
+
|
637
|
+
module SubLineItem
|
638
|
+
extend Orb::Union
|
639
|
+
|
640
|
+
discriminator :type
|
641
|
+
|
642
|
+
variant :matrix, -> { Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::MatrixSubLineItem }
|
643
|
+
|
644
|
+
variant :tier, -> { Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::TierSubLineItem }
|
645
|
+
|
646
|
+
variant :"'null'", -> { Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::OtherSubLineItem }
|
647
|
+
|
648
|
+
class MatrixSubLineItem < Orb::BaseModel
|
649
|
+
# @!attribute amount
|
650
|
+
# The total amount for this sub line item.
|
651
|
+
#
|
652
|
+
# @return [String]
|
653
|
+
required :amount, String
|
654
|
+
|
655
|
+
# @!attribute grouping
|
656
|
+
#
|
657
|
+
# @return [Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::MatrixSubLineItem::Grouping, nil]
|
658
|
+
required :grouping,
|
659
|
+
-> { Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::MatrixSubLineItem::Grouping },
|
660
|
+
nil?: true
|
661
|
+
|
662
|
+
# @!attribute matrix_config
|
663
|
+
#
|
664
|
+
# @return [Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::MatrixSubLineItem::MatrixConfig]
|
665
|
+
required :matrix_config,
|
666
|
+
-> { Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::MatrixSubLineItem::MatrixConfig }
|
667
|
+
|
668
|
+
# @!attribute name
|
669
|
+
#
|
670
|
+
# @return [String]
|
671
|
+
required :name, String
|
672
|
+
|
673
|
+
# @!attribute quantity
|
674
|
+
#
|
675
|
+
# @return [Float]
|
676
|
+
required :quantity, Float
|
677
|
+
|
678
|
+
# @!attribute type
|
679
|
+
#
|
680
|
+
# @return [Symbol, :matrix]
|
681
|
+
required :type, const: :matrix
|
682
|
+
|
683
|
+
# @!parse
|
684
|
+
# # @param amount [String]
|
685
|
+
# # @param grouping [Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::MatrixSubLineItem::Grouping, nil]
|
686
|
+
# # @param matrix_config [Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::MatrixSubLineItem::MatrixConfig]
|
687
|
+
# # @param name [String]
|
688
|
+
# # @param quantity [Float]
|
689
|
+
# # @param type [Symbol, :matrix]
|
690
|
+
# #
|
691
|
+
# def initialize(amount:, grouping:, matrix_config:, name:, quantity:, type: :matrix, **) = super
|
692
|
+
|
693
|
+
# def initialize: (Hash | Orb::BaseModel) -> void
|
694
|
+
|
695
|
+
# @see Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::MatrixSubLineItem#grouping
|
696
|
+
class Grouping < Orb::BaseModel
|
697
|
+
# @!attribute key
|
698
|
+
#
|
699
|
+
# @return [String]
|
700
|
+
required :key, String
|
701
|
+
|
702
|
+
# @!attribute value
|
703
|
+
# No value indicates the default group
|
704
|
+
#
|
705
|
+
# @return [String, nil]
|
706
|
+
required :value, String, nil?: true
|
707
|
+
|
708
|
+
# @!parse
|
709
|
+
# # @param key [String]
|
710
|
+
# # @param value [String, nil]
|
711
|
+
# #
|
712
|
+
# def initialize(key:, value:, **) = super
|
713
|
+
|
714
|
+
# def initialize: (Hash | Orb::BaseModel) -> void
|
715
|
+
end
|
716
|
+
|
717
|
+
# @see Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::MatrixSubLineItem#matrix_config
|
718
|
+
class MatrixConfig < Orb::BaseModel
|
719
|
+
# @!attribute dimension_values
|
720
|
+
# The ordered dimension values for this line item.
|
721
|
+
#
|
722
|
+
# @return [Array<String, nil>]
|
723
|
+
required :dimension_values, Orb::ArrayOf[String, nil?: true]
|
724
|
+
|
725
|
+
# @!parse
|
726
|
+
# # @param dimension_values [Array<String, nil>]
|
727
|
+
# #
|
728
|
+
# def initialize(dimension_values:, **) = super
|
729
|
+
|
730
|
+
# def initialize: (Hash | Orb::BaseModel) -> void
|
731
|
+
end
|
732
|
+
end
|
733
|
+
|
734
|
+
class TierSubLineItem < Orb::BaseModel
|
735
|
+
# @!attribute amount
|
736
|
+
# The total amount for this sub line item.
|
737
|
+
#
|
738
|
+
# @return [String]
|
739
|
+
required :amount, String
|
740
|
+
|
741
|
+
# @!attribute grouping
|
742
|
+
#
|
743
|
+
# @return [Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::TierSubLineItem::Grouping, nil]
|
744
|
+
required :grouping,
|
745
|
+
-> { Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::TierSubLineItem::Grouping },
|
746
|
+
nil?: true
|
747
|
+
|
748
|
+
# @!attribute name
|
749
|
+
#
|
750
|
+
# @return [String]
|
751
|
+
required :name, String
|
752
|
+
|
753
|
+
# @!attribute quantity
|
754
|
+
#
|
755
|
+
# @return [Float]
|
756
|
+
required :quantity, Float
|
757
|
+
|
758
|
+
# @!attribute tier_config
|
759
|
+
#
|
760
|
+
# @return [Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::TierSubLineItem::TierConfig]
|
761
|
+
required :tier_config,
|
762
|
+
-> { Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::TierSubLineItem::TierConfig }
|
763
|
+
|
764
|
+
# @!attribute type
|
765
|
+
#
|
766
|
+
# @return [Symbol, :tier]
|
767
|
+
required :type, const: :tier
|
768
|
+
|
769
|
+
# @!parse
|
770
|
+
# # @param amount [String]
|
771
|
+
# # @param grouping [Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::TierSubLineItem::Grouping, nil]
|
772
|
+
# # @param name [String]
|
773
|
+
# # @param quantity [Float]
|
774
|
+
# # @param tier_config [Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::TierSubLineItem::TierConfig]
|
775
|
+
# # @param type [Symbol, :tier]
|
776
|
+
# #
|
777
|
+
# def initialize(amount:, grouping:, name:, quantity:, tier_config:, type: :tier, **) = super
|
778
|
+
|
779
|
+
# def initialize: (Hash | Orb::BaseModel) -> void
|
780
|
+
|
781
|
+
# @see Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::TierSubLineItem#grouping
|
782
|
+
class Grouping < Orb::BaseModel
|
783
|
+
# @!attribute key
|
784
|
+
#
|
785
|
+
# @return [String]
|
786
|
+
required :key, String
|
787
|
+
|
788
|
+
# @!attribute value
|
789
|
+
# No value indicates the default group
|
790
|
+
#
|
791
|
+
# @return [String, nil]
|
792
|
+
required :value, String, nil?: true
|
793
|
+
|
794
|
+
# @!parse
|
795
|
+
# # @param key [String]
|
796
|
+
# # @param value [String, nil]
|
797
|
+
# #
|
798
|
+
# def initialize(key:, value:, **) = super
|
799
|
+
|
800
|
+
# def initialize: (Hash | Orb::BaseModel) -> void
|
801
|
+
end
|
802
|
+
|
803
|
+
# @see Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::TierSubLineItem#tier_config
|
804
|
+
class TierConfig < Orb::BaseModel
|
805
|
+
# @!attribute first_unit
|
806
|
+
#
|
807
|
+
# @return [Float]
|
808
|
+
required :first_unit, Float
|
809
|
+
|
810
|
+
# @!attribute last_unit
|
811
|
+
#
|
812
|
+
# @return [Float, nil]
|
813
|
+
required :last_unit, Float, nil?: true
|
814
|
+
|
815
|
+
# @!attribute unit_amount
|
816
|
+
#
|
817
|
+
# @return [String]
|
818
|
+
required :unit_amount, String
|
819
|
+
|
820
|
+
# @!parse
|
821
|
+
# # @param first_unit [Float]
|
822
|
+
# # @param last_unit [Float, nil]
|
823
|
+
# # @param unit_amount [String]
|
824
|
+
# #
|
825
|
+
# def initialize(first_unit:, last_unit:, unit_amount:, **) = super
|
826
|
+
|
827
|
+
# def initialize: (Hash | Orb::BaseModel) -> void
|
828
|
+
end
|
829
|
+
end
|
830
|
+
|
831
|
+
class OtherSubLineItem < Orb::BaseModel
|
832
|
+
# @!attribute amount
|
833
|
+
# The total amount for this sub line item.
|
834
|
+
#
|
835
|
+
# @return [String]
|
836
|
+
required :amount, String
|
837
|
+
|
838
|
+
# @!attribute grouping
|
839
|
+
#
|
840
|
+
# @return [Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::OtherSubLineItem::Grouping, nil]
|
841
|
+
required :grouping,
|
842
|
+
-> { Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::OtherSubLineItem::Grouping },
|
843
|
+
nil?: true
|
844
|
+
|
845
|
+
# @!attribute name
|
846
|
+
#
|
847
|
+
# @return [String]
|
848
|
+
required :name, String
|
849
|
+
|
850
|
+
# @!attribute quantity
|
851
|
+
#
|
852
|
+
# @return [Float]
|
853
|
+
required :quantity, Float
|
854
|
+
|
855
|
+
# @!attribute type
|
856
|
+
#
|
857
|
+
# @return [Symbol, :"'null'"]
|
858
|
+
required :type, const: :"'null'"
|
859
|
+
|
860
|
+
# @!parse
|
861
|
+
# # @param amount [String]
|
862
|
+
# # @param grouping [Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::OtherSubLineItem::Grouping, nil]
|
863
|
+
# # @param name [String]
|
864
|
+
# # @param quantity [Float]
|
865
|
+
# # @param type [Symbol, :"'null'"]
|
866
|
+
# #
|
867
|
+
# def initialize(amount:, grouping:, name:, quantity:, type: :"'null'", **) = super
|
868
|
+
|
869
|
+
# def initialize: (Hash | Orb::BaseModel) -> void
|
870
|
+
|
871
|
+
# @see Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::OtherSubLineItem#grouping
|
872
|
+
class Grouping < Orb::BaseModel
|
873
|
+
# @!attribute key
|
874
|
+
#
|
875
|
+
# @return [String]
|
876
|
+
required :key, String
|
877
|
+
|
878
|
+
# @!attribute value
|
879
|
+
# No value indicates the default group
|
880
|
+
#
|
881
|
+
# @return [String, nil]
|
882
|
+
required :value, String, nil?: true
|
883
|
+
|
884
|
+
# @!parse
|
885
|
+
# # @param key [String]
|
886
|
+
# # @param value [String, nil]
|
887
|
+
# #
|
888
|
+
# def initialize(key:, value:, **) = super
|
889
|
+
|
890
|
+
# def initialize: (Hash | Orb::BaseModel) -> void
|
891
|
+
end
|
892
|
+
end
|
893
|
+
|
894
|
+
# @!parse
|
895
|
+
# # @return [Array(Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::MatrixSubLineItem, Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::TierSubLineItem, Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::OtherSubLineItem)]
|
896
|
+
# def self.variants; end
|
897
|
+
end
|
898
|
+
|
899
|
+
class TaxAmount < Orb::BaseModel
|
900
|
+
# @!attribute amount
|
901
|
+
# The amount of additional tax incurred by this tax rate.
|
902
|
+
#
|
903
|
+
# @return [String]
|
904
|
+
required :amount, String
|
905
|
+
|
906
|
+
# @!attribute tax_rate_description
|
907
|
+
# The human-readable description of the applied tax rate.
|
908
|
+
#
|
909
|
+
# @return [String]
|
910
|
+
required :tax_rate_description, String
|
911
|
+
|
912
|
+
# @!attribute tax_rate_percentage
|
913
|
+
# The tax rate percentage, out of 100.
|
914
|
+
#
|
915
|
+
# @return [String, nil]
|
916
|
+
required :tax_rate_percentage, String, nil?: true
|
917
|
+
|
918
|
+
# @!parse
|
919
|
+
# # @param amount [String]
|
920
|
+
# # @param tax_rate_description [String]
|
921
|
+
# # @param tax_rate_percentage [String, nil]
|
922
|
+
# #
|
923
|
+
# def initialize(amount:, tax_rate_description:, tax_rate_percentage:, **) = super
|
924
|
+
|
925
|
+
# def initialize: (Hash | Orb::BaseModel) -> void
|
926
|
+
end
|
927
|
+
end
|
928
|
+
end
|
929
|
+
end
|