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
@@ -101,7 +101,7 @@ module Orb
|
|
101
101
|
# @!attribute discount_intervals
|
102
102
|
# The discount intervals for this subscription sorted by the start_date.
|
103
103
|
#
|
104
|
-
# @return [Array<Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::
|
104
|
+
# @return [Array<Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::Amount, Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::Percentage, Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::Usage>]
|
105
105
|
required :discount_intervals,
|
106
106
|
-> { Orb::Internal::Type::ArrayOf[union: Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval] }
|
107
107
|
|
@@ -243,7 +243,7 @@ module Orb
|
|
243
243
|
# @param default_invoice_memo [String, nil] Determines the default memo on this subscriptions' invoices. Note that if this i
|
244
244
|
# ...
|
245
245
|
#
|
246
|
-
# @param discount_intervals [Array<Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::
|
246
|
+
# @param discount_intervals [Array<Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::Amount, Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::Percentage, Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::Usage>] The discount intervals for this subscription sorted by the start_date.
|
247
247
|
#
|
248
248
|
# @param end_date [Time, nil] The date Orb stops billing for this subscription.
|
249
249
|
#
|
@@ -287,7 +287,7 @@ module Orb
|
|
287
287
|
|
288
288
|
# @!attribute adjustment
|
289
289
|
#
|
290
|
-
# @return [Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::
|
290
|
+
# @return [Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::Minimum, Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::Maximum]
|
291
291
|
required :adjustment,
|
292
292
|
union: -> { Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment }
|
293
293
|
|
@@ -312,7 +312,7 @@ module Orb
|
|
312
312
|
# @!method initialize(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:)
|
313
313
|
# @param id [String]
|
314
314
|
#
|
315
|
-
# @param adjustment [Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::
|
315
|
+
# @param adjustment [Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::Minimum, Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::Maximum]
|
316
316
|
#
|
317
317
|
# @param applies_to_price_interval_ids [Array<String>] The price interval IDs that this adjustment applies to.
|
318
318
|
#
|
@@ -327,21 +327,21 @@ module Orb
|
|
327
327
|
discriminator :adjustment_type
|
328
328
|
|
329
329
|
variant :usage_discount,
|
330
|
-
-> { Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::
|
330
|
+
-> { Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::UsageDiscount }
|
331
331
|
|
332
332
|
variant :amount_discount,
|
333
|
-
-> { Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::
|
333
|
+
-> { Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::AmountDiscount }
|
334
334
|
|
335
335
|
variant :percentage_discount,
|
336
|
-
-> { Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::
|
336
|
+
-> { Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::PercentageDiscount }
|
337
337
|
|
338
338
|
variant :minimum,
|
339
|
-
-> { Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::
|
339
|
+
-> { Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::Minimum }
|
340
340
|
|
341
341
|
variant :maximum,
|
342
|
-
-> { Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::
|
342
|
+
-> { Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::Maximum }
|
343
343
|
|
344
|
-
class
|
344
|
+
class UsageDiscount < Orb::Internal::Type::BaseModel
|
345
345
|
# @!attribute id
|
346
346
|
#
|
347
347
|
# @return [String]
|
@@ -386,7 +386,7 @@ module Orb
|
|
386
386
|
|
387
387
|
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, usage_discount:, adjustment_type: :usage_discount)
|
388
388
|
# Some parameter documentations has been truncated, see
|
389
|
-
# {Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::
|
389
|
+
# {Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::UsageDiscount}
|
390
390
|
# for more details.
|
391
391
|
#
|
392
392
|
# @param id [String]
|
@@ -406,7 +406,7 @@ module Orb
|
|
406
406
|
# @param adjustment_type [Symbol, :usage_discount]
|
407
407
|
end
|
408
408
|
|
409
|
-
class
|
409
|
+
class AmountDiscount < Orb::Internal::Type::BaseModel
|
410
410
|
# @!attribute id
|
411
411
|
#
|
412
412
|
# @return [String]
|
@@ -451,7 +451,7 @@ module Orb
|
|
451
451
|
|
452
452
|
# @!method initialize(id:, amount_discount:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, adjustment_type: :amount_discount)
|
453
453
|
# Some parameter documentations has been truncated, see
|
454
|
-
# {Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::
|
454
|
+
# {Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::AmountDiscount}
|
455
455
|
# for more details.
|
456
456
|
#
|
457
457
|
# @param id [String]
|
@@ -471,7 +471,7 @@ module Orb
|
|
471
471
|
# @param adjustment_type [Symbol, :amount_discount]
|
472
472
|
end
|
473
473
|
|
474
|
-
class
|
474
|
+
class PercentageDiscount < Orb::Internal::Type::BaseModel
|
475
475
|
# @!attribute id
|
476
476
|
#
|
477
477
|
# @return [String]
|
@@ -516,7 +516,7 @@ module Orb
|
|
516
516
|
|
517
517
|
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, percentage_discount:, plan_phase_order:, reason:, adjustment_type: :percentage_discount)
|
518
518
|
# Some parameter documentations has been truncated, see
|
519
|
-
# {Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::
|
519
|
+
# {Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::PercentageDiscount}
|
520
520
|
# for more details.
|
521
521
|
#
|
522
522
|
# @param id [String]
|
@@ -536,7 +536,7 @@ module Orb
|
|
536
536
|
# @param adjustment_type [Symbol, :percentage_discount]
|
537
537
|
end
|
538
538
|
|
539
|
-
class
|
539
|
+
class Minimum < Orb::Internal::Type::BaseModel
|
540
540
|
# @!attribute id
|
541
541
|
#
|
542
542
|
# @return [String]
|
@@ -587,7 +587,7 @@ module Orb
|
|
587
587
|
|
588
588
|
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, item_id:, minimum_amount:, plan_phase_order:, reason:, adjustment_type: :minimum)
|
589
589
|
# Some parameter documentations has been truncated, see
|
590
|
-
# {Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::
|
590
|
+
# {Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::Minimum}
|
591
591
|
# for more details.
|
592
592
|
#
|
593
593
|
# @param id [String]
|
@@ -609,7 +609,7 @@ module Orb
|
|
609
609
|
# @param adjustment_type [Symbol, :minimum]
|
610
610
|
end
|
611
611
|
|
612
|
-
class
|
612
|
+
class Maximum < Orb::Internal::Type::BaseModel
|
613
613
|
# @!attribute id
|
614
614
|
#
|
615
615
|
# @return [String]
|
@@ -654,7 +654,7 @@ module Orb
|
|
654
654
|
|
655
655
|
# @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, maximum_amount:, plan_phase_order:, reason:, adjustment_type: :maximum)
|
656
656
|
# Some parameter documentations has been truncated, see
|
657
|
-
# {Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::
|
657
|
+
# {Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::Maximum}
|
658
658
|
# for more details.
|
659
659
|
#
|
660
660
|
# @param id [String]
|
@@ -675,7 +675,7 @@ module Orb
|
|
675
675
|
end
|
676
676
|
|
677
677
|
# @!method self.variants
|
678
|
-
# @return [Array(Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::
|
678
|
+
# @return [Array(Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::Minimum, Orb::Models::SubscriptionUpdateTrialResponse::AdjustmentInterval::Adjustment::Maximum)]
|
679
679
|
end
|
680
680
|
end
|
681
681
|
|
@@ -725,16 +725,13 @@ module Orb
|
|
725
725
|
|
726
726
|
discriminator :discount_type
|
727
727
|
|
728
|
-
variant :amount,
|
729
|
-
-> { Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::AmountDiscountInterval }
|
728
|
+
variant :amount, -> { Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::Amount }
|
730
729
|
|
731
|
-
variant :percentage,
|
732
|
-
-> { Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::PercentageDiscountInterval }
|
730
|
+
variant :percentage, -> { Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::Percentage }
|
733
731
|
|
734
|
-
variant :usage,
|
735
|
-
-> { Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::UsageDiscountInterval }
|
732
|
+
variant :usage, -> { Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::Usage }
|
736
733
|
|
737
|
-
class
|
734
|
+
class Amount < Orb::Internal::Type::BaseModel
|
738
735
|
# @!attribute amount_discount
|
739
736
|
# Only available if discount_type is `amount`.
|
740
737
|
#
|
@@ -784,7 +781,7 @@ module Orb
|
|
784
781
|
# @param discount_type [Symbol, :amount]
|
785
782
|
end
|
786
783
|
|
787
|
-
class
|
784
|
+
class Percentage < Orb::Internal::Type::BaseModel
|
788
785
|
# @!attribute applies_to_price_ids
|
789
786
|
# The price ids that this discount interval applies to.
|
790
787
|
#
|
@@ -823,8 +820,8 @@ module Orb
|
|
823
820
|
|
824
821
|
# @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, percentage_discount:, start_date:, discount_type: :percentage)
|
825
822
|
# Some parameter documentations has been truncated, see
|
826
|
-
# {Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::
|
827
|
-
#
|
823
|
+
# {Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::Percentage} for
|
824
|
+
# more details.
|
828
825
|
#
|
829
826
|
# @param applies_to_price_ids [Array<String>] The price ids that this discount interval applies to.
|
830
827
|
#
|
@@ -840,7 +837,7 @@ module Orb
|
|
840
837
|
# @param discount_type [Symbol, :percentage]
|
841
838
|
end
|
842
839
|
|
843
|
-
class
|
840
|
+
class Usage < Orb::Internal::Type::BaseModel
|
844
841
|
# @!attribute applies_to_price_ids
|
845
842
|
# The price ids that this discount interval applies to.
|
846
843
|
#
|
@@ -879,8 +876,8 @@ module Orb
|
|
879
876
|
|
880
877
|
# @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, start_date:, usage_discount:, discount_type: :usage)
|
881
878
|
# Some parameter documentations has been truncated, see
|
882
|
-
# {Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::
|
883
|
-
#
|
879
|
+
# {Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::Usage} for more
|
880
|
+
# details.
|
884
881
|
#
|
885
882
|
# @param applies_to_price_ids [Array<String>] The price ids that this discount interval applies to.
|
886
883
|
#
|
@@ -897,7 +894,7 @@ module Orb
|
|
897
894
|
end
|
898
895
|
|
899
896
|
# @!method self.variants
|
900
|
-
# @return [Array(Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::
|
897
|
+
# @return [Array(Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::Amount, Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::Percentage, Orb::Models::SubscriptionUpdateTrialResponse::DiscountInterval::Usage)]
|
901
898
|
end
|
902
899
|
|
903
900
|
class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel
|
@@ -1101,7 +1098,7 @@ module Orb
|
|
1101
1098
|
# For more on the types of prices, see
|
1102
1099
|
# [the core concepts documentation](/core-concepts#plan-and-price)
|
1103
1100
|
#
|
1104
|
-
# @return [Orb::Models::Price::
|
1101
|
+
# @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]
|
1105
1102
|
required :price, union: -> { Orb::Models::Price }
|
1106
1103
|
|
1107
1104
|
# @!attribute start_date
|
@@ -1144,7 +1141,7 @@ module Orb
|
|
1144
1141
|
# @param fixed_fee_quantity_transitions [Array<Orb::Models::SubscriptionUpdateTrialResponse::PriceInterval::FixedFeeQuantityTransition>, nil] The fixed fee quantity transitions for this price interval. This is only relevan
|
1145
1142
|
# ...
|
1146
1143
|
#
|
1147
|
-
# @param price [Orb::Models::Price::
|
1144
|
+
# @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] The Price resource represents a price that can be billed on a subscription, resu
|
1148
1145
|
# ...
|
1149
1146
|
#
|
1150
1147
|
# @param start_date [Time] The start date of the price interval. This is the date that Orb starts billing f
|
data/lib/orb/models.rb
ADDED
@@ -0,0 +1,220 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Orb
|
4
|
+
Alert = Orb::Models::Alert
|
5
|
+
|
6
|
+
AlertCreateForCustomerParams = Orb::Models::AlertCreateForCustomerParams
|
7
|
+
|
8
|
+
AlertCreateForExternalCustomerParams = Orb::Models::AlertCreateForExternalCustomerParams
|
9
|
+
|
10
|
+
AlertCreateForSubscriptionParams = Orb::Models::AlertCreateForSubscriptionParams
|
11
|
+
|
12
|
+
AlertDisableParams = Orb::Models::AlertDisableParams
|
13
|
+
|
14
|
+
AlertEnableParams = Orb::Models::AlertEnableParams
|
15
|
+
|
16
|
+
AlertListParams = Orb::Models::AlertListParams
|
17
|
+
|
18
|
+
AlertRetrieveParams = Orb::Models::AlertRetrieveParams
|
19
|
+
|
20
|
+
AlertUpdateParams = Orb::Models::AlertUpdateParams
|
21
|
+
|
22
|
+
AmountDiscount = Orb::Models::AmountDiscount
|
23
|
+
|
24
|
+
BillableMetric = Orb::Models::BillableMetric
|
25
|
+
|
26
|
+
BillingCycleRelativeDate = Orb::Models::BillingCycleRelativeDate
|
27
|
+
|
28
|
+
Coupon = Orb::Models::Coupon
|
29
|
+
|
30
|
+
CouponArchiveParams = Orb::Models::CouponArchiveParams
|
31
|
+
|
32
|
+
CouponCreateParams = Orb::Models::CouponCreateParams
|
33
|
+
|
34
|
+
CouponFetchParams = Orb::Models::CouponFetchParams
|
35
|
+
|
36
|
+
CouponListParams = Orb::Models::CouponListParams
|
37
|
+
|
38
|
+
Coupons = Orb::Models::Coupons
|
39
|
+
|
40
|
+
CreditNote = Orb::Models::CreditNote
|
41
|
+
|
42
|
+
CreditNoteCreateParams = Orb::Models::CreditNoteCreateParams
|
43
|
+
|
44
|
+
CreditNoteFetchParams = Orb::Models::CreditNoteFetchParams
|
45
|
+
|
46
|
+
CreditNoteListParams = Orb::Models::CreditNoteListParams
|
47
|
+
|
48
|
+
Customer = Orb::Models::Customer
|
49
|
+
|
50
|
+
CustomerCreateParams = Orb::Models::CustomerCreateParams
|
51
|
+
|
52
|
+
CustomerDeleteParams = Orb::Models::CustomerDeleteParams
|
53
|
+
|
54
|
+
CustomerFetchByExternalIDParams = Orb::Models::CustomerFetchByExternalIDParams
|
55
|
+
|
56
|
+
CustomerFetchParams = Orb::Models::CustomerFetchParams
|
57
|
+
|
58
|
+
CustomerListParams = Orb::Models::CustomerListParams
|
59
|
+
|
60
|
+
Customers = Orb::Models::Customers
|
61
|
+
|
62
|
+
CustomerSyncPaymentMethodsFromGatewayByExternalCustomerIDParams =
|
63
|
+
Orb::Models::CustomerSyncPaymentMethodsFromGatewayByExternalCustomerIDParams
|
64
|
+
|
65
|
+
CustomerSyncPaymentMethodsFromGatewayParams = Orb::Models::CustomerSyncPaymentMethodsFromGatewayParams
|
66
|
+
|
67
|
+
CustomerUpdateByExternalIDParams = Orb::Models::CustomerUpdateByExternalIDParams
|
68
|
+
|
69
|
+
CustomerUpdateParams = Orb::Models::CustomerUpdateParams
|
70
|
+
|
71
|
+
DimensionalPriceGroup = Orb::Models::DimensionalPriceGroup
|
72
|
+
|
73
|
+
DimensionalPriceGroupCreateParams = Orb::Models::DimensionalPriceGroupCreateParams
|
74
|
+
|
75
|
+
DimensionalPriceGroupListParams = Orb::Models::DimensionalPriceGroupListParams
|
76
|
+
|
77
|
+
DimensionalPriceGroupRetrieveParams = Orb::Models::DimensionalPriceGroupRetrieveParams
|
78
|
+
|
79
|
+
DimensionalPriceGroups = Orb::Models::DimensionalPriceGroups
|
80
|
+
|
81
|
+
DimensionalPriceGroupsAPI = Orb::Models::DimensionalPriceGroupsAPI
|
82
|
+
|
83
|
+
Discount = Orb::Models::Discount
|
84
|
+
|
85
|
+
EvaluatePriceGroup = Orb::Models::EvaluatePriceGroup
|
86
|
+
|
87
|
+
EventDeprecateParams = Orb::Models::EventDeprecateParams
|
88
|
+
|
89
|
+
EventIngestParams = Orb::Models::EventIngestParams
|
90
|
+
|
91
|
+
Events = Orb::Models::Events
|
92
|
+
|
93
|
+
EventSearchParams = Orb::Models::EventSearchParams
|
94
|
+
|
95
|
+
EventUpdateParams = Orb::Models::EventUpdateParams
|
96
|
+
|
97
|
+
Invoice = Orb::Models::Invoice
|
98
|
+
|
99
|
+
InvoiceCreateParams = Orb::Models::InvoiceCreateParams
|
100
|
+
|
101
|
+
InvoiceFetchParams = Orb::Models::InvoiceFetchParams
|
102
|
+
|
103
|
+
InvoiceFetchUpcomingParams = Orb::Models::InvoiceFetchUpcomingParams
|
104
|
+
|
105
|
+
InvoiceIssueParams = Orb::Models::InvoiceIssueParams
|
106
|
+
|
107
|
+
InvoiceLevelDiscount = Orb::Models::InvoiceLevelDiscount
|
108
|
+
|
109
|
+
InvoiceLineItemCreateParams = Orb::Models::InvoiceLineItemCreateParams
|
110
|
+
|
111
|
+
InvoiceListParams = Orb::Models::InvoiceListParams
|
112
|
+
|
113
|
+
InvoiceMarkPaidParams = Orb::Models::InvoiceMarkPaidParams
|
114
|
+
|
115
|
+
InvoicePayParams = Orb::Models::InvoicePayParams
|
116
|
+
|
117
|
+
InvoiceUpdateParams = Orb::Models::InvoiceUpdateParams
|
118
|
+
|
119
|
+
InvoiceVoidParams = Orb::Models::InvoiceVoidParams
|
120
|
+
|
121
|
+
Item = Orb::Models::Item
|
122
|
+
|
123
|
+
ItemCreateParams = Orb::Models::ItemCreateParams
|
124
|
+
|
125
|
+
ItemFetchParams = Orb::Models::ItemFetchParams
|
126
|
+
|
127
|
+
ItemListParams = Orb::Models::ItemListParams
|
128
|
+
|
129
|
+
ItemUpdateParams = Orb::Models::ItemUpdateParams
|
130
|
+
|
131
|
+
MetricCreateParams = Orb::Models::MetricCreateParams
|
132
|
+
|
133
|
+
MetricFetchParams = Orb::Models::MetricFetchParams
|
134
|
+
|
135
|
+
MetricListParams = Orb::Models::MetricListParams
|
136
|
+
|
137
|
+
MetricUpdateParams = Orb::Models::MetricUpdateParams
|
138
|
+
|
139
|
+
PaginationMetadata = Orb::Models::PaginationMetadata
|
140
|
+
|
141
|
+
PercentageDiscount = Orb::Models::PercentageDiscount
|
142
|
+
|
143
|
+
Plan = Orb::Models::Plan
|
144
|
+
|
145
|
+
PlanCreateParams = Orb::Models::PlanCreateParams
|
146
|
+
|
147
|
+
PlanFetchParams = Orb::Models::PlanFetchParams
|
148
|
+
|
149
|
+
PlanListParams = Orb::Models::PlanListParams
|
150
|
+
|
151
|
+
Plans = Orb::Models::Plans
|
152
|
+
|
153
|
+
PlanUpdateParams = Orb::Models::PlanUpdateParams
|
154
|
+
|
155
|
+
Price = Orb::Models::Price
|
156
|
+
|
157
|
+
PriceCreateParams = Orb::Models::PriceCreateParams
|
158
|
+
|
159
|
+
PriceEvaluateParams = Orb::Models::PriceEvaluateParams
|
160
|
+
|
161
|
+
PriceFetchParams = Orb::Models::PriceFetchParams
|
162
|
+
|
163
|
+
PriceListParams = Orb::Models::PriceListParams
|
164
|
+
|
165
|
+
Prices = Orb::Models::Prices
|
166
|
+
|
167
|
+
PriceUpdateParams = Orb::Models::PriceUpdateParams
|
168
|
+
|
169
|
+
Subscription = Orb::Models::Subscription
|
170
|
+
|
171
|
+
SubscriptionCancelParams = Orb::Models::SubscriptionCancelParams
|
172
|
+
|
173
|
+
SubscriptionChangeApplyParams = Orb::Models::SubscriptionChangeApplyParams
|
174
|
+
|
175
|
+
SubscriptionChangeCancelParams = Orb::Models::SubscriptionChangeCancelParams
|
176
|
+
|
177
|
+
SubscriptionChangeRetrieveParams = Orb::Models::SubscriptionChangeRetrieveParams
|
178
|
+
|
179
|
+
SubscriptionCreateParams = Orb::Models::SubscriptionCreateParams
|
180
|
+
|
181
|
+
SubscriptionFetchCostsParams = Orb::Models::SubscriptionFetchCostsParams
|
182
|
+
|
183
|
+
SubscriptionFetchParams = Orb::Models::SubscriptionFetchParams
|
184
|
+
|
185
|
+
SubscriptionFetchScheduleParams = Orb::Models::SubscriptionFetchScheduleParams
|
186
|
+
|
187
|
+
SubscriptionFetchUsageParams = Orb::Models::SubscriptionFetchUsageParams
|
188
|
+
|
189
|
+
SubscriptionListParams = Orb::Models::SubscriptionListParams
|
190
|
+
|
191
|
+
SubscriptionPriceIntervalsParams = Orb::Models::SubscriptionPriceIntervalsParams
|
192
|
+
|
193
|
+
SubscriptionsAPI = Orb::Models::SubscriptionsAPI
|
194
|
+
|
195
|
+
SubscriptionSchedulePlanChangeParams = Orb::Models::SubscriptionSchedulePlanChangeParams
|
196
|
+
|
197
|
+
SubscriptionTriggerPhaseParams = Orb::Models::SubscriptionTriggerPhaseParams
|
198
|
+
|
199
|
+
SubscriptionUnscheduleCancellationParams = Orb::Models::SubscriptionUnscheduleCancellationParams
|
200
|
+
|
201
|
+
SubscriptionUnscheduleFixedFeeQuantityUpdatesParams =
|
202
|
+
Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesParams
|
203
|
+
|
204
|
+
SubscriptionUnschedulePendingPlanChangesParams =
|
205
|
+
Orb::Models::SubscriptionUnschedulePendingPlanChangesParams
|
206
|
+
|
207
|
+
SubscriptionUpdateFixedFeeQuantityParams = Orb::Models::SubscriptionUpdateFixedFeeQuantityParams
|
208
|
+
|
209
|
+
SubscriptionUpdateParams = Orb::Models::SubscriptionUpdateParams
|
210
|
+
|
211
|
+
SubscriptionUpdateTrialParams = Orb::Models::SubscriptionUpdateTrialParams
|
212
|
+
|
213
|
+
SubscriptionUsage = Orb::Models::SubscriptionUsage
|
214
|
+
|
215
|
+
TopLevelPingParams = Orb::Models::TopLevelPingParams
|
216
|
+
|
217
|
+
TrialDiscount = Orb::Models::TrialDiscount
|
218
|
+
|
219
|
+
UsageDiscount = Orb::Models::UsageDiscount
|
220
|
+
end
|
data/lib/orb/request_options.rb
CHANGED
@@ -65,10 +65,9 @@ module Orb
|
|
65
65
|
# @return [Float, nil]
|
66
66
|
optional :timeout, Float
|
67
67
|
|
68
|
-
# @!
|
69
|
-
#
|
70
|
-
#
|
71
|
-
#
|
72
|
-
# # @param values [Hash{Symbol=>Object}]
|
68
|
+
# @!method initialize(values = {})
|
69
|
+
# Returns a new instance of RequestOptions.
|
70
|
+
#
|
71
|
+
# @param values [Hash{Symbol=>Object}]
|
73
72
|
end
|
74
73
|
end
|
@@ -14,7 +14,7 @@ module Orb
|
|
14
14
|
#
|
15
15
|
# @overload create(discount:, redemption_code:, duration_in_months: nil, max_redemptions: nil, request_options: {})
|
16
16
|
#
|
17
|
-
# @param discount [Orb::Models::CouponCreateParams::Discount::
|
17
|
+
# @param discount [Orb::Models::CouponCreateParams::Discount::Percentage, Orb::Models::CouponCreateParams::Discount::Amount]
|
18
18
|
#
|
19
19
|
# @param redemption_code [String] This string can be used to redeem this coupon for a given subscription.
|
20
20
|
#
|
@@ -117,7 +117,7 @@ module Orb
|
|
117
117
|
#
|
118
118
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
119
119
|
#
|
120
|
-
# @return [Orb::Internal::Page<Orb::Models::Customers::Credits::LedgerListResponse::
|
120
|
+
# @return [Orb::Internal::Page<Orb::Models::Customers::Credits::LedgerListResponse::Increment, Orb::Models::Customers::Credits::LedgerListResponse::Decrement, Orb::Models::Customers::Credits::LedgerListResponse::ExpirationChange, Orb::Models::Customers::Credits::LedgerListResponse::CreditBlockExpiry, Orb::Models::Customers::Credits::LedgerListResponse::Void, Orb::Models::Customers::Credits::LedgerListResponse::VoidInitiated, Orb::Models::Customers::Credits::LedgerListResponse::Amendment>]
|
121
121
|
#
|
122
122
|
# @see Orb::Models::Customers::Credits::LedgerListParams
|
123
123
|
def list(customer_id, params = {})
|
@@ -289,7 +289,7 @@ module Orb
|
|
289
289
|
#
|
290
290
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
291
291
|
#
|
292
|
-
# @return [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::
|
292
|
+
# @return [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Increment, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Decrement, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::ExpirationChange, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::CreditBlockExpiry, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Void, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidInitiated, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Amendment]
|
293
293
|
#
|
294
294
|
# @see Orb::Models::Customers::Credits::LedgerCreateEntryParams
|
295
295
|
def create_entry(customer_id, params)
|
@@ -456,7 +456,7 @@ module Orb
|
|
456
456
|
#
|
457
457
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
458
458
|
#
|
459
|
-
# @return [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::
|
459
|
+
# @return [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Increment, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Decrement, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::ExpirationChange, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::CreditBlockExpiry, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Void, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidInitiated, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Amendment]
|
460
460
|
#
|
461
461
|
# @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams
|
462
462
|
def create_entry_by_external_id(external_customer_id, params)
|
@@ -584,7 +584,7 @@ module Orb
|
|
584
584
|
#
|
585
585
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
586
586
|
#
|
587
|
-
# @return [Orb::Internal::Page<Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::
|
587
|
+
# @return [Orb::Internal::Page<Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Increment, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Decrement, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChange, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiry, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Void, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiated, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Amendment>]
|
588
588
|
#
|
589
589
|
# @see Orb::Models::Customers::Credits::LedgerListByExternalIDParams
|
590
590
|
def list_by_external_id(external_customer_id, params = {})
|
@@ -68,7 +68,7 @@ module Orb
|
|
68
68
|
#
|
69
69
|
# @param shipping_address [Orb::Models::CustomerCreateParams::ShippingAddress, nil]
|
70
70
|
#
|
71
|
-
# @param tax_configuration [Orb::Models::CustomerCreateParams::TaxConfiguration::
|
71
|
+
# @param tax_configuration [Orb::Models::CustomerCreateParams::TaxConfiguration::Avalara, Orb::Models::CustomerCreateParams::TaxConfiguration::Taxjar, nil]
|
72
72
|
#
|
73
73
|
# @param tax_id [Orb::Models::CustomerCreateParams::TaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad
|
74
74
|
# ...
|
@@ -142,7 +142,7 @@ module Orb
|
|
142
142
|
#
|
143
143
|
# @param shipping_address [Orb::Models::CustomerUpdateParams::ShippingAddress, nil]
|
144
144
|
#
|
145
|
-
# @param tax_configuration [Orb::Models::CustomerUpdateParams::TaxConfiguration::
|
145
|
+
# @param tax_configuration [Orb::Models::CustomerUpdateParams::TaxConfiguration::Avalara, Orb::Models::CustomerUpdateParams::TaxConfiguration::Taxjar, nil]
|
146
146
|
#
|
147
147
|
# @param tax_id [Orb::Models::CustomerUpdateParams::TaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad
|
148
148
|
# ...
|
@@ -390,7 +390,7 @@ module Orb
|
|
390
390
|
#
|
391
391
|
# @param shipping_address [Orb::Models::CustomerUpdateByExternalIDParams::ShippingAddress, nil]
|
392
392
|
#
|
393
|
-
# @param tax_configuration [Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::
|
393
|
+
# @param tax_configuration [Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::Avalara, Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::Taxjar, nil]
|
394
394
|
#
|
395
395
|
# @param tax_id [Orb::Models::CustomerUpdateByExternalIDParams::TaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad
|
396
396
|
# ...
|
data/lib/orb/resources/plans.rb
CHANGED
@@ -18,7 +18,7 @@ module Orb
|
|
18
18
|
#
|
19
19
|
# @param name [String]
|
20
20
|
#
|
21
|
-
# @param prices [Array<Orb::Models::PlanCreateParams::Price::
|
21
|
+
# @param prices [Array<Orb::Models::PlanCreateParams::Price::Unit, Orb::Models::PlanCreateParams::Price::Package, Orb::Models::PlanCreateParams::Price::Matrix, Orb::Models::PlanCreateParams::Price::Tiered, Orb::Models::PlanCreateParams::Price::TieredBps, Orb::Models::PlanCreateParams::Price::Bps, Orb::Models::PlanCreateParams::Price::BulkBps, Orb::Models::PlanCreateParams::Price::Bulk, Orb::Models::PlanCreateParams::Price::ThresholdTotalAmount, Orb::Models::PlanCreateParams::Price::TieredPackage, Orb::Models::PlanCreateParams::Price::TieredWithMinimum, Orb::Models::PlanCreateParams::Price::UnitWithPercent, Orb::Models::PlanCreateParams::Price::PackageWithAllocation, Orb::Models::PlanCreateParams::Price::TieredWithProration, Orb::Models::PlanCreateParams::Price::UnitWithProration, Orb::Models::PlanCreateParams::Price::GroupedAllocation, Orb::Models::PlanCreateParams::Price::GroupedWithProratedMinimum, Orb::Models::PlanCreateParams::Price::GroupedWithMeteredMinimum, Orb::Models::PlanCreateParams::Price::MatrixWithDisplayName, Orb::Models::PlanCreateParams::Price::BulkWithProration, Orb::Models::PlanCreateParams::Price::GroupedTieredPackage, Orb::Models::PlanCreateParams::Price::MaxGroupTieredPackage, Orb::Models::PlanCreateParams::Price::ScalableMatrixWithUnitPricing, Orb::Models::PlanCreateParams::Price::ScalableMatrixWithTieredPricing, Orb::Models::PlanCreateParams::Price::CumulativeGroupedBulk>] Prices for this plan. If the plan has phases, this includes prices across all ph
|
22
22
|
# ...
|
23
23
|
#
|
24
24
|
# @param default_invoice_memo [String, nil] Free-form text which is available on the invoice PDF and the Orb invoice portal.
|
@@ -20,7 +20,7 @@ module Orb
|
|
20
20
|
#
|
21
21
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
22
22
|
#
|
23
|
-
# @return [Orb::Models::Price::
|
23
|
+
# @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]
|
24
24
|
#
|
25
25
|
# @see Orb::Models::Prices::ExternalPriceIDUpdateParams
|
26
26
|
def update(external_price_id, params = {})
|
@@ -43,7 +43,7 @@ module Orb
|
|
43
43
|
# @param external_price_id [String]
|
44
44
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
45
45
|
#
|
46
|
-
# @return [Orb::Models::Price::
|
46
|
+
# @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]
|
47
47
|
#
|
48
48
|
# @see Orb::Models::Prices::ExternalPriceIDFetchParams
|
49
49
|
def fetch(external_price_id, params = {})
|