orb-billing 0.1.0.pre.alpha.37 → 0.1.0.pre.alpha.39
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/README.md +29 -5
- data/lib/orb/client.rb +4 -0
- data/lib/orb/internal/page.rb +6 -2
- data/lib/orb/internal/transport/base_client.rb +3 -3
- data/lib/orb/internal/transport/pooled_net_requester.rb +2 -2
- data/lib/orb/internal/type/array_of.rb +5 -3
- data/lib/orb/internal/type/base_model.rb +19 -16
- data/lib/orb/internal/type/base_page.rb +4 -1
- data/lib/orb/internal/type/{boolean_model.rb → boolean.rb} +2 -2
- data/lib/orb/internal/type/converter.rb +26 -23
- data/lib/orb/internal/type/enum.rb +10 -8
- data/lib/orb/internal/type/hash_of.rb +3 -1
- data/lib/orb/internal/util.rb +29 -50
- data/lib/orb/models/alert.rb +10 -10
- data/lib/orb/models/alert_create_for_customer_params.rb +3 -3
- data/lib/orb/models/alert_create_for_external_customer_params.rb +3 -3
- data/lib/orb/models/alert_create_for_subscription_params.rb +3 -3
- data/lib/orb/models/alert_list_params.rb +5 -5
- data/lib/orb/models/alert_update_params.rb +3 -3
- data/lib/orb/models/amount_discount.rb +1 -1
- data/lib/orb/models/billable_metric.rb +7 -7
- data/lib/orb/models/coupon.rb +7 -7
- data/lib/orb/models/coupon_create_params.rb +2 -2
- data/lib/orb/models/coupon_list_params.rb +3 -3
- data/lib/orb/models/coupons/subscription_list_params.rb +1 -1
- data/lib/orb/models/credit_note.rb +1 -1
- data/lib/orb/models/credit_note_list_params.rb +5 -5
- data/lib/orb/models/customer.rb +237 -237
- data/lib/orb/models/customer_create_params.rb +229 -229
- data/lib/orb/models/customer_list_params.rb +5 -5
- data/lib/orb/models/customer_update_by_external_id_params.rb +230 -230
- data/lib/orb/models/customer_update_params.rb +230 -230
- data/lib/orb/models/customers/balance_transaction_create_response.rb +2 -2
- data/lib/orb/models/customers/balance_transaction_list_params.rb +5 -5
- data/lib/orb/models/customers/balance_transaction_list_response.rb +2 -2
- data/lib/orb/models/customers/cost_list_by_external_id_params.rb +6 -6
- data/lib/orb/models/customers/cost_list_params.rb +6 -6
- data/lib/orb/models/customers/credit_list_by_external_id_params.rb +3 -3
- data/lib/orb/models/customers/credit_list_params.rb +3 -3
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +22 -22
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +22 -22
- data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +22 -22
- data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +22 -22
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +5 -5
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +22 -22
- data/lib/orb/models/customers/credits/ledger_list_params.rb +5 -5
- data/lib/orb/models/customers/credits/ledger_list_response.rb +22 -22
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +10 -10
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +9 -9
- data/lib/orb/models/customers/credits/top_up_create_params.rb +10 -10
- data/lib/orb/models/customers/credits/top_up_create_response.rb +9 -9
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +1 -1
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +9 -9
- data/lib/orb/models/customers/credits/top_up_list_params.rb +1 -1
- data/lib/orb/models/customers/credits/top_up_list_response.rb +9 -9
- data/lib/orb/models/dimensional_price_group.rb +7 -7
- data/lib/orb/models/dimensional_price_group_create_params.rb +2 -2
- data/lib/orb/models/dimensional_price_group_list_params.rb +1 -1
- data/lib/orb/models/evaluate_price_group.rb +1 -1
- data/lib/orb/models/event_ingest_params.rb +8 -8
- data/lib/orb/models/event_ingest_response.rb +4 -4
- data/lib/orb/models/event_search_params.rb +5 -5
- data/lib/orb/models/event_search_response.rb +9 -9
- data/lib/orb/models/event_update_params.rb +4 -4
- data/lib/orb/models/events/backfill_close_response.rb +8 -8
- data/lib/orb/models/events/backfill_create_params.rb +12 -12
- data/lib/orb/models/events/backfill_create_response.rb +8 -8
- data/lib/orb/models/events/backfill_fetch_response.rb +8 -8
- data/lib/orb/models/events/backfill_list_params.rb +1 -1
- data/lib/orb/models/events/backfill_list_response.rb +8 -8
- data/lib/orb/models/events/backfill_revert_response.rb +8 -8
- data/lib/orb/models/events/event_volumes.rb +1 -1
- data/lib/orb/models/events/volume_list_params.rb +7 -7
- data/lib/orb/models/invoice.rb +278 -278
- data/lib/orb/models/invoice_create_params.rb +13 -12
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +274 -274
- data/lib/orb/models/invoice_issue_params.rb +5 -5
- data/lib/orb/models/invoice_line_item_create_params.rb +1 -1
- data/lib/orb/models/invoice_line_item_create_response.rb +32 -32
- data/lib/orb/models/invoice_list_params.rb +13 -13
- data/lib/orb/models/invoice_update_params.rb +2 -2
- data/lib/orb/models/item.rb +2 -2
- data/lib/orb/models/item_list_params.rb +1 -1
- data/lib/orb/models/metric_create_params.rb +2 -2
- data/lib/orb/models/metric_list_params.rb +5 -5
- data/lib/orb/models/metric_update_params.rb +2 -2
- data/lib/orb/models/pagination_metadata.rb +1 -1
- data/lib/orb/models/percentage_discount.rb +2 -2
- data/lib/orb/models/plan.rb +40 -40
- data/lib/orb/models/plan_create_params.rb +292 -292
- data/lib/orb/models/plan_list_params.rb +5 -5
- data/lib/orb/models/plan_update_params.rb +4 -4
- data/lib/orb/models/plans/external_plan_id_update_params.rb +4 -4
- data/lib/orb/models/price.rb +186 -186
- data/lib/orb/models/price_create_params.rb +21 -21
- data/lib/orb/models/price_evaluate_params.rb +4 -4
- data/lib/orb/models/price_list_params.rb +1 -1
- data/lib/orb/models/price_update_params.rb +2 -2
- data/lib/orb/models/prices/external_price_id_update_params.rb +2 -2
- data/lib/orb/models/subscription.rb +120 -93
- data/lib/orb/models/subscription_cancel_params.rb +4 -4
- data/lib/orb/models/subscription_cancel_response.rb +156 -78
- data/lib/orb/models/subscription_change_apply_params.rb +33 -0
- data/lib/orb/models/subscription_change_apply_response.rb +1372 -0
- data/lib/orb/models/subscription_change_cancel_params.rb +19 -0
- data/lib/orb/models/subscription_change_cancel_response.rb +1372 -0
- data/lib/orb/models/subscription_change_retrieve_params.rb +19 -0
- data/lib/orb/models/subscription_change_retrieve_response.rb +1372 -0
- data/lib/orb/models/subscription_create_params.rb +705 -705
- data/lib/orb/models/subscription_create_response.rb +156 -78
- data/lib/orb/models/subscription_fetch_costs_params.rb +6 -6
- data/lib/orb/models/subscription_fetch_schedule_params.rb +5 -5
- data/lib/orb/models/subscription_fetch_schedule_response.rb +2 -2
- data/lib/orb/models/subscription_fetch_usage_params.rb +8 -8
- data/lib/orb/models/subscription_list_params.rb +5 -5
- data/lib/orb/models/subscription_price_intervals_params.rb +358 -358
- data/lib/orb/models/subscription_price_intervals_response.rb +158 -78
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +715 -715
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +158 -78
- data/lib/orb/models/subscription_trigger_phase_params.rb +4 -4
- data/lib/orb/models/subscription_trigger_phase_response.rb +158 -78
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +158 -78
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +159 -79
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +158 -78
- data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +9 -9
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +158 -78
- data/lib/orb/models/subscription_update_params.rb +11 -11
- data/lib/orb/models/subscription_update_trial_params.rb +4 -4
- data/lib/orb/models/subscription_update_trial_response.rb +158 -78
- data/lib/orb/models/trial_discount.rb +1 -1
- data/lib/orb/models/usage_discount.rb +2 -2
- data/lib/orb/request_options.rb +7 -7
- data/lib/orb/resources/alerts.rb +40 -35
- data/lib/orb/resources/coupons/subscriptions.rb +3 -3
- data/lib/orb/resources/coupons.rb +9 -9
- data/lib/orb/resources/credit_notes.rb +10 -5
- data/lib/orb/resources/customers/balance_transactions.rb +28 -23
- data/lib/orb/resources/customers/costs.rb +232 -232
- data/lib/orb/resources/customers/credits/ledger.rb +348 -338
- data/lib/orb/resources/customers/credits/top_ups.rb +12 -12
- data/lib/orb/resources/customers/credits.rb +8 -8
- data/lib/orb/resources/customers.rb +61 -56
- data/lib/orb/resources/dimensional_price_groups.rb +6 -6
- data/lib/orb/resources/events/backfills.rb +49 -49
- data/lib/orb/resources/events/volume.rb +10 -10
- data/lib/orb/resources/events.rb +295 -295
- data/lib/orb/resources/invoice_line_items.rb +1 -1
- data/lib/orb/resources/invoices.rb +40 -31
- data/lib/orb/resources/items.rb +1 -1
- data/lib/orb/resources/metrics.rb +13 -8
- data/lib/orb/resources/plans/external_plan_id.rb +14 -14
- data/lib/orb/resources/plans.rb +24 -19
- data/lib/orb/resources/prices/external_price_id.rb +4 -4
- data/lib/orb/resources/prices.rb +30 -30
- data/lib/orb/resources/subscription_changes.rb +87 -0
- data/lib/orb/resources/subscriptions.rb +817 -807
- data/lib/orb/resources/top_level.rb +4 -4
- data/lib/orb/version.rb +1 -1
- data/lib/orb.rb +8 -1
- data/rbi/lib/orb/client.rbi +5 -4
- data/rbi/lib/orb/errors.rbi +3 -6
- data/rbi/lib/orb/internal/page.rbi +3 -6
- data/rbi/lib/orb/internal/transport/base_client.rbi +13 -27
- data/rbi/lib/orb/internal/transport/pooled_net_requester.rbi +7 -13
- data/rbi/lib/orb/internal/type/array_of.rbi +10 -18
- data/rbi/lib/orb/internal/type/base_model.rbi +45 -64
- data/rbi/lib/orb/internal/type/base_page.rbi +5 -10
- data/rbi/lib/orb/internal/type/{boolean_model.rbi → boolean.rbi} +5 -9
- data/rbi/lib/orb/internal/type/converter.rbi +25 -31
- data/rbi/lib/orb/internal/type/enum.rbi +14 -20
- data/rbi/lib/orb/internal/type/hash_of.rbi +8 -16
- data/rbi/lib/orb/internal/type/request_parameters.rbi +1 -2
- data/rbi/lib/orb/internal/type/union.rbi +10 -20
- data/rbi/lib/orb/internal/type/unknown.rbi +4 -8
- data/rbi/lib/orb/internal/util.rbi +40 -72
- data/rbi/lib/orb/internal.rbi +1 -1
- data/rbi/lib/orb/models/alert.rbi +21 -33
- data/rbi/lib/orb/models/alert_create_for_customer_params.rbi +8 -13
- data/rbi/lib/orb/models/alert_create_for_external_customer_params.rbi +8 -13
- data/rbi/lib/orb/models/alert_create_for_subscription_params.rbi +8 -13
- data/rbi/lib/orb/models/alert_disable_params.rbi +2 -4
- data/rbi/lib/orb/models/alert_enable_params.rbi +2 -4
- data/rbi/lib/orb/models/alert_list_params.rbi +3 -6
- data/rbi/lib/orb/models/alert_retrieve_params.rbi +2 -4
- data/rbi/lib/orb/models/alert_update_params.rbi +7 -11
- data/rbi/lib/orb/models/amount_discount.rbi +4 -7
- data/rbi/lib/orb/models/billable_metric.rbi +10 -13
- data/rbi/lib/orb/models/billing_cycle_relative_date.rbi +1 -2
- data/rbi/lib/orb/models/coupon.rbi +9 -11
- data/rbi/lib/orb/models/coupon_archive_params.rbi +2 -4
- data/rbi/lib/orb/models/coupon_create_params.rbi +8 -14
- data/rbi/lib/orb/models/coupon_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/coupon_list_params.rbi +3 -4
- data/rbi/lib/orb/models/coupons/subscription_list_params.rbi +3 -5
- data/rbi/lib/orb/models/credit_note.rbi +22 -45
- data/rbi/lib/orb/models/credit_note_create_params.rbi +5 -10
- data/rbi/lib/orb/models/credit_note_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/credit_note_list_params.rbi +3 -6
- data/rbi/lib/orb/models/customer.rbi +256 -281
- data/rbi/lib/orb/models/customer_create_params.rbi +251 -276
- data/rbi/lib/orb/models/customer_delete_params.rbi +2 -4
- data/rbi/lib/orb/models/customer_fetch_by_external_id_params.rbi +2 -4
- data/rbi/lib/orb/models/customer_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/customer_list_params.rbi +3 -6
- data/rbi/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +2 -4
- data/rbi/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rbi +2 -4
- data/rbi/lib/orb/models/customer_update_by_external_id_params.rbi +252 -277
- data/rbi/lib/orb/models/customer_update_params.rbi +252 -277
- data/rbi/lib/orb/models/customers/balance_transaction_create_params.rbi +3 -6
- data/rbi/lib/orb/models/customers/balance_transaction_create_response.rbi +10 -19
- data/rbi/lib/orb/models/customers/balance_transaction_list_params.rbi +3 -6
- data/rbi/lib/orb/models/customers/balance_transaction_list_response.rbi +10 -19
- data/rbi/lib/orb/models/customers/cost_list_by_external_id_params.rbi +8 -10
- data/rbi/lib/orb/models/customers/cost_list_by_external_id_response.rbi +6 -12
- data/rbi/lib/orb/models/customers/cost_list_params.rbi +8 -10
- data/rbi/lib/orb/models/customers/cost_list_response.rbi +6 -12
- data/rbi/lib/orb/models/customers/credit_list_by_external_id_params.rbi +3 -4
- data/rbi/lib/orb/models/customers/credit_list_by_external_id_response.rbi +2 -4
- data/rbi/lib/orb/models/customers/credit_list_params.rbi +3 -4
- data/rbi/lib/orb/models/customers/credit_list_response.rbi +2 -4
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +26 -33
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +79 -136
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_params.rbi +26 -33
- data/rbi/lib/orb/models/customers/credits/ledger_create_entry_response.rbi +78 -135
- data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +5 -10
- data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +79 -136
- data/rbi/lib/orb/models/customers/credits/ledger_list_params.rbi +5 -10
- data/rbi/lib/orb/models/customers/credits/ledger_list_response.rbi +74 -131
- data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +13 -19
- data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +12 -18
- data/rbi/lib/orb/models/customers/credits/top_up_create_params.rbi +13 -19
- data/rbi/lib/orb/models/customers/credits/top_up_create_response.rbi +12 -18
- data/rbi/lib/orb/models/customers/credits/top_up_delete_by_external_id_params.rbi +2 -4
- data/rbi/lib/orb/models/customers/credits/top_up_delete_params.rbi +2 -4
- data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rbi +3 -5
- data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +12 -18
- data/rbi/lib/orb/models/customers/credits/top_up_list_params.rbi +3 -5
- data/rbi/lib/orb/models/customers/credits/top_up_list_response.rbi +12 -18
- data/rbi/lib/orb/models/dimensional_price_group.rbi +8 -9
- data/rbi/lib/orb/models/dimensional_price_group_create_params.rbi +4 -7
- data/rbi/lib/orb/models/dimensional_price_group_list_params.rbi +3 -5
- data/rbi/lib/orb/models/dimensional_price_group_retrieve_params.rbi +2 -4
- data/rbi/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +2 -4
- data/rbi/lib/orb/models/dimensional_price_groups.rbi +2 -4
- data/rbi/lib/orb/models/discount.rbi +1 -2
- data/rbi/lib/orb/models/evaluate_price_group.rbi +3 -6
- data/rbi/lib/orb/models/event_deprecate_params.rbi +2 -4
- data/rbi/lib/orb/models/event_deprecate_response.rbi +2 -4
- data/rbi/lib/orb/models/event_ingest_params.rbi +10 -13
- data/rbi/lib/orb/models/event_ingest_response.rbi +10 -16
- data/rbi/lib/orb/models/event_search_params.rbi +7 -9
- data/rbi/lib/orb/models/event_search_response.rbi +11 -14
- data/rbi/lib/orb/models/event_update_params.rbi +5 -6
- data/rbi/lib/orb/models/event_update_response.rbi +2 -4
- data/rbi/lib/orb/models/events/backfill_close_params.rbi +2 -4
- data/rbi/lib/orb/models/events/backfill_close_response.rbi +10 -14
- data/rbi/lib/orb/models/events/backfill_create_params.rbi +13 -16
- data/rbi/lib/orb/models/events/backfill_create_response.rbi +10 -14
- data/rbi/lib/orb/models/events/backfill_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/events/backfill_fetch_response.rbi +10 -14
- data/rbi/lib/orb/models/events/backfill_list_params.rbi +3 -5
- data/rbi/lib/orb/models/events/backfill_list_response.rbi +10 -14
- data/rbi/lib/orb/models/events/backfill_revert_params.rbi +2 -4
- data/rbi/lib/orb/models/events/backfill_revert_response.rbi +10 -14
- data/rbi/lib/orb/models/events/event_volumes.rbi +5 -9
- data/rbi/lib/orb/models/events/volume_list_params.rbi +9 -11
- data/rbi/lib/orb/models/invoice.rbi +388 -465
- data/rbi/lib/orb/models/invoice_create_params.rbi +19 -26
- data/rbi/lib/orb/models/invoice_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/invoice_fetch_upcoming_params.rbi +2 -4
- data/rbi/lib/orb/models/invoice_fetch_upcoming_response.rbi +381 -460
- data/rbi/lib/orb/models/invoice_issue_params.rbi +6 -8
- data/rbi/lib/orb/models/invoice_level_discount.rbi +1 -2
- data/rbi/lib/orb/models/invoice_line_item_create_params.rbi +3 -5
- data/rbi/lib/orb/models/invoice_line_item_create_response.rbi +101 -143
- data/rbi/lib/orb/models/invoice_list_params.rbi +8 -13
- data/rbi/lib/orb/models/invoice_mark_paid_params.rbi +2 -4
- data/rbi/lib/orb/models/invoice_pay_params.rbi +2 -4
- data/rbi/lib/orb/models/invoice_update_params.rbi +4 -6
- data/rbi/lib/orb/models/invoice_void_params.rbi +2 -4
- data/rbi/lib/orb/models/item.rbi +7 -12
- data/rbi/lib/orb/models/item_create_params.rbi +2 -4
- data/rbi/lib/orb/models/item_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/item_list_params.rbi +3 -5
- data/rbi/lib/orb/models/item_update_params.rbi +5 -10
- data/rbi/lib/orb/models/metric_create_params.rbi +4 -6
- data/rbi/lib/orb/models/metric_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/metric_list_params.rbi +3 -6
- data/rbi/lib/orb/models/metric_update_params.rbi +4 -6
- data/rbi/lib/orb/models/pagination_metadata.rbi +2 -4
- data/rbi/lib/orb/models/percentage_discount.rbi +5 -8
- data/rbi/lib/orb/models/plan.rbi +180 -219
- data/rbi/lib/orb/models/plan_create_params.rbi +670 -951
- data/rbi/lib/orb/models/plan_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/plan_list_params.rbi +4 -8
- data/rbi/lib/orb/models/plan_update_params.rbi +6 -8
- data/rbi/lib/orb/models/plans/external_plan_id_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/plans/external_plan_id_update_params.rbi +6 -8
- data/rbi/lib/orb/models/price.rbi +827 -1494
- data/rbi/lib/orb/models/price_create_params.rbi +60 -101
- data/rbi/lib/orb/models/price_evaluate_params.rbi +6 -9
- data/rbi/lib/orb/models/price_evaluate_response.rbi +2 -4
- data/rbi/lib/orb/models/price_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/price_list_params.rbi +3 -5
- data/rbi/lib/orb/models/price_update_params.rbi +4 -6
- data/rbi/lib/orb/models/prices/external_price_id_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/prices/external_price_id_update_params.rbi +4 -6
- data/rbi/lib/orb/models/subscription.rbi +167 -187
- data/rbi/lib/orb/models/subscription_cancel_params.rbi +5 -7
- data/rbi/lib/orb/models/subscription_cancel_response.rbi +224 -178
- data/rbi/lib/orb/models/subscription_change_apply_params.rbi +40 -0
- data/rbi/lib/orb/models/subscription_change_apply_response.rbi +1554 -0
- data/rbi/lib/orb/models/subscription_change_cancel_params.rbi +18 -0
- data/rbi/lib/orb/models/subscription_change_cancel_response.rbi +1565 -0
- data/rbi/lib/orb/models/subscription_change_retrieve_params.rbi +18 -0
- data/rbi/lib/orb/models/subscription_change_retrieve_response.rbi +1581 -0
- data/rbi/lib/orb/models/subscription_create_params.rbi +1372 -1968
- data/rbi/lib/orb/models/subscription_create_response.rbi +224 -178
- data/rbi/lib/orb/models/subscription_fetch_costs_params.rbi +8 -10
- data/rbi/lib/orb/models/subscription_fetch_costs_response.rbi +6 -12
- data/rbi/lib/orb/models/subscription_fetch_params.rbi +2 -4
- data/rbi/lib/orb/models/subscription_fetch_schedule_params.rbi +3 -6
- data/rbi/lib/orb/models/subscription_fetch_schedule_response.rbi +6 -10
- data/rbi/lib/orb/models/subscription_fetch_usage_params.rbi +12 -17
- data/rbi/lib/orb/models/subscription_list_params.rbi +4 -8
- data/rbi/lib/orb/models/subscription_price_intervals_params.rbi +772 -1124
- data/rbi/lib/orb/models/subscription_price_intervals_response.rbi +228 -178
- data/rbi/lib/orb/models/subscription_schedule_plan_change_params.rbi +1396 -1993
- data/rbi/lib/orb/models/subscription_schedule_plan_change_response.rbi +238 -182
- data/rbi/lib/orb/models/subscription_trigger_phase_params.rbi +5 -7
- data/rbi/lib/orb/models/subscription_trigger_phase_response.rbi +224 -178
- data/rbi/lib/orb/models/subscription_unschedule_cancellation_params.rbi +2 -4
- data/rbi/lib/orb/models/subscription_unschedule_cancellation_response.rbi +238 -182
- data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +2 -4
- data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +265 -199
- data/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rbi +2 -4
- data/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +264 -198
- data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_params.rbi +11 -15
- data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_response.rbi +238 -182
- data/rbi/lib/orb/models/subscription_update_params.rbi +12 -15
- data/rbi/lib/orb/models/subscription_update_trial_params.rbi +6 -9
- data/rbi/lib/orb/models/subscription_update_trial_response.rbi +224 -178
- data/rbi/lib/orb/models/subscription_usage.rbi +24 -43
- data/rbi/lib/orb/models/subscriptions.rbi +2 -4
- data/rbi/lib/orb/models/top_level_ping_params.rbi +2 -4
- data/rbi/lib/orb/models/top_level_ping_response.rbi +2 -4
- data/rbi/lib/orb/models/trial_discount.rbi +4 -8
- data/rbi/lib/orb/models/usage_discount.rbi +5 -8
- data/rbi/lib/orb/request_options.rbi +9 -11
- data/rbi/lib/orb/resources/alerts.rbi +44 -60
- data/rbi/lib/orb/resources/coupons/subscriptions.rbi +6 -9
- data/rbi/lib/orb/resources/coupons.rbi +18 -25
- data/rbi/lib/orb/resources/credit_notes.rbi +9 -15
- data/rbi/lib/orb/resources/customers/balance_transactions.rbi +26 -31
- data/rbi/lib/orb/resources/customers/costs.rbi +241 -246
- data/rbi/lib/orb/resources/customers/credits/ledger.rbi +387 -396
- data/rbi/lib/orb/resources/customers/credits/top_ups.rbi +29 -40
- data/rbi/lib/orb/resources/customers/credits.rbi +15 -20
- data/rbi/lib/orb/resources/customers.rbi +407 -417
- data/rbi/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi +2 -4
- data/rbi/lib/orb/resources/dimensional_price_groups.rbi +13 -19
- data/rbi/lib/orb/resources/events/backfills.rbi +61 -69
- data/rbi/lib/orb/resources/events/volume.rbi +19 -22
- data/rbi/lib/orb/resources/events.rbi +311 -319
- data/rbi/lib/orb/resources/invoice_line_items.rbi +4 -7
- data/rbi/lib/orb/resources/invoices.rbi +62 -76
- data/rbi/lib/orb/resources/items.rbi +7 -14
- data/rbi/lib/orb/resources/metrics.rbi +17 -25
- data/rbi/lib/orb/resources/plans/external_plan_id.rbi +21 -25
- data/rbi/lib/orb/resources/plans.rbi +63 -71
- data/rbi/lib/orb/resources/prices/external_price_id.rbi +9 -13
- data/rbi/lib/orb/resources/prices.rbi +77 -87
- data/rbi/lib/orb/resources/subscription_changes.rbi +61 -0
- data/rbi/lib/orb/resources/subscriptions.rbi +933 -963
- data/rbi/lib/orb/resources/top_level.rbi +6 -8
- data/rbi/lib/orb/version.rbi +1 -1
- data/sig/orb/client.rbs +2 -0
- data/sig/orb/internal/type/array_of.rbs +2 -2
- data/sig/orb/internal/type/{boolean_model.rbs → boolean.rbs} +1 -1
- data/sig/orb/internal/util.rbs +5 -5
- data/sig/orb/models/subscription.rbs +14 -0
- data/sig/orb/models/subscription_cancel_response.rbs +47 -2
- data/sig/orb/models/subscription_change_apply_params.rbs +24 -0
- data/sig/orb/models/subscription_change_apply_response.rbs +784 -0
- data/sig/orb/models/subscription_change_cancel_params.rbs +15 -0
- data/sig/orb/models/subscription_change_cancel_response.rbs +784 -0
- data/sig/orb/models/subscription_change_retrieve_params.rbs +15 -0
- data/sig/orb/models/subscription_change_retrieve_response.rbs +784 -0
- data/sig/orb/models/subscription_create_response.rbs +47 -2
- data/sig/orb/models/subscription_price_intervals_response.rbs +47 -2
- data/sig/orb/models/subscription_schedule_plan_change_response.rbs +47 -2
- data/sig/orb/models/subscription_trigger_phase_response.rbs +47 -2
- data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +47 -2
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +47 -2
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +47 -2
- data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +47 -2
- data/sig/orb/models/subscription_update_trial_response.rbs +47 -2
- data/sig/orb/resources/customers.rbs +2 -2
- data/sig/orb/resources/subscription_changes.rbs +24 -0
- data/sig/orb/version.rbs +1 -1
- metadata +26 -5
@@ -5,7 +5,7 @@ module Orb
|
|
5
5
|
module Customers
|
6
6
|
module Credits
|
7
7
|
# The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid
|
8
|
-
#
|
8
|
+
# credits within Orb.
|
9
9
|
#
|
10
10
|
# @see Orb::Resources::Customers::Credits::Ledger#list_by_external_id
|
11
11
|
module LedgerListByExternalIDResponse
|
@@ -94,9 +94,9 @@ module Orb
|
|
94
94
|
|
95
95
|
# @!attribute metadata
|
96
96
|
# User specified key-value pairs for the resource. If not present, this defaults
|
97
|
-
#
|
98
|
-
#
|
99
|
-
#
|
97
|
+
# to an empty dictionary. Individual keys can be removed by setting the value to
|
98
|
+
# `null`, and the entire metadata mapping can be cleared by setting `metadata` to
|
99
|
+
# `null`.
|
100
100
|
#
|
101
101
|
# @return [Hash{Symbol=>String}]
|
102
102
|
required :metadata, Orb::Internal::Type::HashOf[String]
|
@@ -266,9 +266,9 @@ module Orb
|
|
266
266
|
|
267
267
|
# @!attribute metadata
|
268
268
|
# User specified key-value pairs for the resource. If not present, this defaults
|
269
|
-
#
|
270
|
-
#
|
271
|
-
#
|
269
|
+
# to an empty dictionary. Individual keys can be removed by setting the value to
|
270
|
+
# `null`, and the entire metadata mapping can be cleared by setting `metadata` to
|
271
|
+
# `null`.
|
272
272
|
#
|
273
273
|
# @return [Hash{Symbol=>String}]
|
274
274
|
required :metadata, Orb::Internal::Type::HashOf[String]
|
@@ -459,9 +459,9 @@ module Orb
|
|
459
459
|
|
460
460
|
# @!attribute metadata
|
461
461
|
# User specified key-value pairs for the resource. If not present, this defaults
|
462
|
-
#
|
463
|
-
#
|
464
|
-
#
|
462
|
+
# to an empty dictionary. Individual keys can be removed by setting the value to
|
463
|
+
# `null`, and the entire metadata mapping can be cleared by setting `metadata` to
|
464
|
+
# `null`.
|
465
465
|
#
|
466
466
|
# @return [Hash{Symbol=>String}]
|
467
467
|
required :metadata, Orb::Internal::Type::HashOf[String]
|
@@ -638,9 +638,9 @@ module Orb
|
|
638
638
|
|
639
639
|
# @!attribute metadata
|
640
640
|
# User specified key-value pairs for the resource. If not present, this defaults
|
641
|
-
#
|
642
|
-
#
|
643
|
-
#
|
641
|
+
# to an empty dictionary. Individual keys can be removed by setting the value to
|
642
|
+
# `null`, and the entire metadata mapping can be cleared by setting `metadata` to
|
643
|
+
# `null`.
|
644
644
|
#
|
645
645
|
# @return [Hash{Symbol=>String}]
|
646
646
|
required :metadata, Orb::Internal::Type::HashOf[String]
|
@@ -810,9 +810,9 @@ module Orb
|
|
810
810
|
|
811
811
|
# @!attribute metadata
|
812
812
|
# User specified key-value pairs for the resource. If not present, this defaults
|
813
|
-
#
|
814
|
-
#
|
815
|
-
#
|
813
|
+
# to an empty dictionary. Individual keys can be removed by setting the value to
|
814
|
+
# `null`, and the entire metadata mapping can be cleared by setting `metadata` to
|
815
|
+
# `null`.
|
816
816
|
#
|
817
817
|
# @return [Hash{Symbol=>String}]
|
818
818
|
required :metadata, Orb::Internal::Type::HashOf[String]
|
@@ -996,9 +996,9 @@ module Orb
|
|
996
996
|
|
997
997
|
# @!attribute metadata
|
998
998
|
# User specified key-value pairs for the resource. If not present, this defaults
|
999
|
-
#
|
1000
|
-
#
|
1001
|
-
#
|
999
|
+
# to an empty dictionary. Individual keys can be removed by setting the value to
|
1000
|
+
# `null`, and the entire metadata mapping can be cleared by setting `metadata` to
|
1001
|
+
# `null`.
|
1002
1002
|
#
|
1003
1003
|
# @return [Hash{Symbol=>String}]
|
1004
1004
|
required :metadata, Orb::Internal::Type::HashOf[String]
|
@@ -1189,9 +1189,9 @@ module Orb
|
|
1189
1189
|
|
1190
1190
|
# @!attribute metadata
|
1191
1191
|
# User specified key-value pairs for the resource. If not present, this defaults
|
1192
|
-
#
|
1193
|
-
#
|
1194
|
-
#
|
1192
|
+
# to an empty dictionary. Individual keys can be removed by setting the value to
|
1193
|
+
# `null`, and the entire metadata mapping can be cleared by setting `metadata` to
|
1194
|
+
# `null`.
|
1195
1195
|
#
|
1196
1196
|
# @return [Hash{Symbol=>String}]
|
1197
1197
|
required :metadata, Orb::Internal::Type::HashOf[String]
|
@@ -13,22 +13,22 @@ module Orb
|
|
13
13
|
# @!attribute created_at_gt
|
14
14
|
#
|
15
15
|
# @return [Time, nil]
|
16
|
-
optional :created_at_gt, Time,
|
16
|
+
optional :created_at_gt, Time, nil?: true
|
17
17
|
|
18
18
|
# @!attribute created_at_gte
|
19
19
|
#
|
20
20
|
# @return [Time, nil]
|
21
|
-
optional :created_at_gte, Time,
|
21
|
+
optional :created_at_gte, Time, nil?: true
|
22
22
|
|
23
23
|
# @!attribute created_at_lt
|
24
24
|
#
|
25
25
|
# @return [Time, nil]
|
26
|
-
optional :created_at_lt, Time,
|
26
|
+
optional :created_at_lt, Time, nil?: true
|
27
27
|
|
28
28
|
# @!attribute created_at_lte
|
29
29
|
#
|
30
30
|
# @return [Time, nil]
|
31
|
-
optional :created_at_lte, Time,
|
31
|
+
optional :created_at_lte, Time, nil?: true
|
32
32
|
|
33
33
|
# @!attribute currency
|
34
34
|
# The ledger currency or custom pricing unit to use.
|
@@ -38,7 +38,7 @@ module Orb
|
|
38
38
|
|
39
39
|
# @!attribute cursor
|
40
40
|
# Cursor for pagination. This can be populated by the `next_cursor` value returned
|
41
|
-
#
|
41
|
+
# from the initial request.
|
42
42
|
#
|
43
43
|
# @return [String, nil]
|
44
44
|
optional :cursor, String, nil?: true
|
@@ -5,7 +5,7 @@ module Orb
|
|
5
5
|
module Customers
|
6
6
|
module Credits
|
7
7
|
# The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid
|
8
|
-
#
|
8
|
+
# credits within Orb.
|
9
9
|
#
|
10
10
|
# @see Orb::Resources::Customers::Credits::Ledger#list
|
11
11
|
module LedgerListResponse
|
@@ -91,9 +91,9 @@ module Orb
|
|
91
91
|
|
92
92
|
# @!attribute metadata
|
93
93
|
# User specified key-value pairs for the resource. If not present, this defaults
|
94
|
-
#
|
95
|
-
#
|
96
|
-
#
|
94
|
+
# to an empty dictionary. Individual keys can be removed by setting the value to
|
95
|
+
# `null`, and the entire metadata mapping can be cleared by setting `metadata` to
|
96
|
+
# `null`.
|
97
97
|
#
|
98
98
|
# @return [Hash{Symbol=>String}]
|
99
99
|
required :metadata, Orb::Internal::Type::HashOf[String]
|
@@ -263,9 +263,9 @@ module Orb
|
|
263
263
|
|
264
264
|
# @!attribute metadata
|
265
265
|
# User specified key-value pairs for the resource. If not present, this defaults
|
266
|
-
#
|
267
|
-
#
|
268
|
-
#
|
266
|
+
# to an empty dictionary. Individual keys can be removed by setting the value to
|
267
|
+
# `null`, and the entire metadata mapping can be cleared by setting `metadata` to
|
268
|
+
# `null`.
|
269
269
|
#
|
270
270
|
# @return [Hash{Symbol=>String}]
|
271
271
|
required :metadata, Orb::Internal::Type::HashOf[String]
|
@@ -456,9 +456,9 @@ module Orb
|
|
456
456
|
|
457
457
|
# @!attribute metadata
|
458
458
|
# User specified key-value pairs for the resource. If not present, this defaults
|
459
|
-
#
|
460
|
-
#
|
461
|
-
#
|
459
|
+
# to an empty dictionary. Individual keys can be removed by setting the value to
|
460
|
+
# `null`, and the entire metadata mapping can be cleared by setting `metadata` to
|
461
|
+
# `null`.
|
462
462
|
#
|
463
463
|
# @return [Hash{Symbol=>String}]
|
464
464
|
required :metadata, Orb::Internal::Type::HashOf[String]
|
@@ -635,9 +635,9 @@ module Orb
|
|
635
635
|
|
636
636
|
# @!attribute metadata
|
637
637
|
# User specified key-value pairs for the resource. If not present, this defaults
|
638
|
-
#
|
639
|
-
#
|
640
|
-
#
|
638
|
+
# to an empty dictionary. Individual keys can be removed by setting the value to
|
639
|
+
# `null`, and the entire metadata mapping can be cleared by setting `metadata` to
|
640
|
+
# `null`.
|
641
641
|
#
|
642
642
|
# @return [Hash{Symbol=>String}]
|
643
643
|
required :metadata, Orb::Internal::Type::HashOf[String]
|
@@ -806,9 +806,9 @@ module Orb
|
|
806
806
|
|
807
807
|
# @!attribute metadata
|
808
808
|
# User specified key-value pairs for the resource. If not present, this defaults
|
809
|
-
#
|
810
|
-
#
|
811
|
-
#
|
809
|
+
# to an empty dictionary. Individual keys can be removed by setting the value to
|
810
|
+
# `null`, and the entire metadata mapping can be cleared by setting `metadata` to
|
811
|
+
# `null`.
|
812
812
|
#
|
813
813
|
# @return [Hash{Symbol=>String}]
|
814
814
|
required :metadata, Orb::Internal::Type::HashOf[String]
|
@@ -992,9 +992,9 @@ module Orb
|
|
992
992
|
|
993
993
|
# @!attribute metadata
|
994
994
|
# User specified key-value pairs for the resource. If not present, this defaults
|
995
|
-
#
|
996
|
-
#
|
997
|
-
#
|
995
|
+
# to an empty dictionary. Individual keys can be removed by setting the value to
|
996
|
+
# `null`, and the entire metadata mapping can be cleared by setting `metadata` to
|
997
|
+
# `null`.
|
998
998
|
#
|
999
999
|
# @return [Hash{Symbol=>String}]
|
1000
1000
|
required :metadata, Orb::Internal::Type::HashOf[String]
|
@@ -1185,9 +1185,9 @@ module Orb
|
|
1185
1185
|
|
1186
1186
|
# @!attribute metadata
|
1187
1187
|
# User specified key-value pairs for the resource. If not present, this defaults
|
1188
|
-
#
|
1189
|
-
#
|
1190
|
-
#
|
1188
|
+
# to an empty dictionary. Individual keys can be removed by setting the value to
|
1189
|
+
# `null`, and the entire metadata mapping can be cleared by setting `metadata` to
|
1190
|
+
# `null`.
|
1191
1191
|
#
|
1192
1192
|
# @return [Hash{Symbol=>String}]
|
1193
1193
|
required :metadata, Orb::Internal::Type::HashOf[String]
|
@@ -18,7 +18,7 @@ module Orb
|
|
18
18
|
|
19
19
|
# @!attribute currency
|
20
20
|
# The currency or custom pricing unit to use for this top-up. If this is a
|
21
|
-
#
|
21
|
+
# real-world currency, it must match the customer's invoicing currency.
|
22
22
|
#
|
23
23
|
# @return [String]
|
24
24
|
required :currency, String
|
@@ -38,21 +38,21 @@ module Orb
|
|
38
38
|
|
39
39
|
# @!attribute threshold
|
40
40
|
# The threshold at which to trigger the top-up. If the balance is at or below this
|
41
|
-
#
|
41
|
+
# threshold, the top-up will be triggered.
|
42
42
|
#
|
43
43
|
# @return [String]
|
44
44
|
required :threshold, String
|
45
45
|
|
46
46
|
# @!attribute active_from
|
47
47
|
# The date from which the top-up is active. If unspecified, the top-up is active
|
48
|
-
#
|
48
|
+
# immediately.
|
49
49
|
#
|
50
50
|
# @return [Time, nil]
|
51
51
|
optional :active_from, Time, nil?: true
|
52
52
|
|
53
53
|
# @!attribute expires_after
|
54
54
|
# The number of days or months after which the top-up expires. If unspecified, it
|
55
|
-
#
|
55
|
+
# does not expire.
|
56
56
|
#
|
57
57
|
# @return [Integer, nil]
|
58
58
|
optional :expires_after, Integer, nil?: true
|
@@ -96,15 +96,15 @@ module Orb
|
|
96
96
|
class InvoiceSettings < Orb::Internal::Type::BaseModel
|
97
97
|
# @!attribute auto_collection
|
98
98
|
# Whether the credits purchase invoice should auto collect with the customer's
|
99
|
-
#
|
99
|
+
# saved payment method.
|
100
100
|
#
|
101
101
|
# @return [Boolean]
|
102
|
-
required :auto_collection, Orb::Internal::Type::
|
102
|
+
required :auto_collection, Orb::Internal::Type::Boolean
|
103
103
|
|
104
104
|
# @!attribute net_terms
|
105
105
|
# The net terms determines the difference between the invoice date and the issue
|
106
|
-
#
|
107
|
-
#
|
106
|
+
# date for the invoice. If you intend the invoice to be due on issue, set this
|
107
|
+
# to 0.
|
108
108
|
#
|
109
109
|
# @return [Integer]
|
110
110
|
required :net_terms, Integer
|
@@ -117,10 +117,10 @@ module Orb
|
|
117
117
|
|
118
118
|
# @!attribute [r] require_successful_payment
|
119
119
|
# If true, new credit blocks created by this top-up will require that the
|
120
|
-
#
|
120
|
+
# corresponding invoice is paid before they can be drawn down from.
|
121
121
|
#
|
122
122
|
# @return [Boolean, nil]
|
123
|
-
optional :require_successful_payment, Orb::Internal::Type::
|
123
|
+
optional :require_successful_payment, Orb::Internal::Type::Boolean
|
124
124
|
|
125
125
|
# @!parse
|
126
126
|
# # @return [Boolean]
|
@@ -19,7 +19,7 @@ module Orb
|
|
19
19
|
|
20
20
|
# @!attribute currency
|
21
21
|
# The currency or custom pricing unit to use for this top-up. If this is a
|
22
|
-
#
|
22
|
+
# real-world currency, it must match the customer's invoicing currency.
|
23
23
|
#
|
24
24
|
# @return [String]
|
25
25
|
required :currency, String
|
@@ -39,14 +39,14 @@ module Orb
|
|
39
39
|
|
40
40
|
# @!attribute threshold
|
41
41
|
# The threshold at which to trigger the top-up. If the balance is at or below this
|
42
|
-
#
|
42
|
+
# threshold, the top-up will be triggered.
|
43
43
|
#
|
44
44
|
# @return [String]
|
45
45
|
required :threshold, String
|
46
46
|
|
47
47
|
# @!attribute expires_after
|
48
48
|
# The number of days or months after which the top-up expires. If unspecified, it
|
49
|
-
#
|
49
|
+
# does not expire.
|
50
50
|
#
|
51
51
|
# @return [Integer, nil]
|
52
52
|
optional :expires_after, Integer, nil?: true
|
@@ -89,15 +89,15 @@ module Orb
|
|
89
89
|
class InvoiceSettings < Orb::Internal::Type::BaseModel
|
90
90
|
# @!attribute auto_collection
|
91
91
|
# Whether the credits purchase invoice should auto collect with the customer's
|
92
|
-
#
|
92
|
+
# saved payment method.
|
93
93
|
#
|
94
94
|
# @return [Boolean]
|
95
|
-
required :auto_collection, Orb::Internal::Type::
|
95
|
+
required :auto_collection, Orb::Internal::Type::Boolean
|
96
96
|
|
97
97
|
# @!attribute net_terms
|
98
98
|
# The net terms determines the difference between the invoice date and the issue
|
99
|
-
#
|
100
|
-
#
|
99
|
+
# date for the invoice. If you intend the invoice to be due on issue, set this
|
100
|
+
# to 0.
|
101
101
|
#
|
102
102
|
# @return [Integer]
|
103
103
|
required :net_terms, Integer
|
@@ -110,10 +110,10 @@ module Orb
|
|
110
110
|
|
111
111
|
# @!attribute [r] require_successful_payment
|
112
112
|
# If true, new credit blocks created by this top-up will require that the
|
113
|
-
#
|
113
|
+
# corresponding invoice is paid before they can be drawn down from.
|
114
114
|
#
|
115
115
|
# @return [Boolean, nil]
|
116
|
-
optional :require_successful_payment, Orb::Internal::Type::
|
116
|
+
optional :require_successful_payment, Orb::Internal::Type::Boolean
|
117
117
|
|
118
118
|
# @!parse
|
119
119
|
# # @return [Boolean]
|
@@ -18,7 +18,7 @@ module Orb
|
|
18
18
|
|
19
19
|
# @!attribute currency
|
20
20
|
# The currency or custom pricing unit to use for this top-up. If this is a
|
21
|
-
#
|
21
|
+
# real-world currency, it must match the customer's invoicing currency.
|
22
22
|
#
|
23
23
|
# @return [String]
|
24
24
|
required :currency, String
|
@@ -37,21 +37,21 @@ module Orb
|
|
37
37
|
|
38
38
|
# @!attribute threshold
|
39
39
|
# The threshold at which to trigger the top-up. If the balance is at or below this
|
40
|
-
#
|
40
|
+
# threshold, the top-up will be triggered.
|
41
41
|
#
|
42
42
|
# @return [String]
|
43
43
|
required :threshold, String
|
44
44
|
|
45
45
|
# @!attribute active_from
|
46
46
|
# The date from which the top-up is active. If unspecified, the top-up is active
|
47
|
-
#
|
47
|
+
# immediately.
|
48
48
|
#
|
49
49
|
# @return [Time, nil]
|
50
50
|
optional :active_from, Time, nil?: true
|
51
51
|
|
52
52
|
# @!attribute expires_after
|
53
53
|
# The number of days or months after which the top-up expires. If unspecified, it
|
54
|
-
#
|
54
|
+
# does not expire.
|
55
55
|
#
|
56
56
|
# @return [Integer, nil]
|
57
57
|
optional :expires_after, Integer, nil?: true
|
@@ -95,15 +95,15 @@ module Orb
|
|
95
95
|
class InvoiceSettings < Orb::Internal::Type::BaseModel
|
96
96
|
# @!attribute auto_collection
|
97
97
|
# Whether the credits purchase invoice should auto collect with the customer's
|
98
|
-
#
|
98
|
+
# saved payment method.
|
99
99
|
#
|
100
100
|
# @return [Boolean]
|
101
|
-
required :auto_collection, Orb::Internal::Type::
|
101
|
+
required :auto_collection, Orb::Internal::Type::Boolean
|
102
102
|
|
103
103
|
# @!attribute net_terms
|
104
104
|
# The net terms determines the difference between the invoice date and the issue
|
105
|
-
#
|
106
|
-
#
|
105
|
+
# date for the invoice. If you intend the invoice to be due on issue, set this
|
106
|
+
# to 0.
|
107
107
|
#
|
108
108
|
# @return [Integer]
|
109
109
|
required :net_terms, Integer
|
@@ -116,10 +116,10 @@ module Orb
|
|
116
116
|
|
117
117
|
# @!attribute [r] require_successful_payment
|
118
118
|
# If true, new credit blocks created by this top-up will require that the
|
119
|
-
#
|
119
|
+
# corresponding invoice is paid before they can be drawn down from.
|
120
120
|
#
|
121
121
|
# @return [Boolean, nil]
|
122
|
-
optional :require_successful_payment, Orb::Internal::Type::
|
122
|
+
optional :require_successful_payment, Orb::Internal::Type::Boolean
|
123
123
|
|
124
124
|
# @!parse
|
125
125
|
# # @return [Boolean]
|
@@ -19,7 +19,7 @@ module Orb
|
|
19
19
|
|
20
20
|
# @!attribute currency
|
21
21
|
# The currency or custom pricing unit to use for this top-up. If this is a
|
22
|
-
#
|
22
|
+
# real-world currency, it must match the customer's invoicing currency.
|
23
23
|
#
|
24
24
|
# @return [String]
|
25
25
|
required :currency, String
|
@@ -38,14 +38,14 @@ module Orb
|
|
38
38
|
|
39
39
|
# @!attribute threshold
|
40
40
|
# The threshold at which to trigger the top-up. If the balance is at or below this
|
41
|
-
#
|
41
|
+
# threshold, the top-up will be triggered.
|
42
42
|
#
|
43
43
|
# @return [String]
|
44
44
|
required :threshold, String
|
45
45
|
|
46
46
|
# @!attribute expires_after
|
47
47
|
# The number of days or months after which the top-up expires. If unspecified, it
|
48
|
-
#
|
48
|
+
# does not expire.
|
49
49
|
#
|
50
50
|
# @return [Integer, nil]
|
51
51
|
optional :expires_after, Integer, nil?: true
|
@@ -88,15 +88,15 @@ module Orb
|
|
88
88
|
class InvoiceSettings < Orb::Internal::Type::BaseModel
|
89
89
|
# @!attribute auto_collection
|
90
90
|
# Whether the credits purchase invoice should auto collect with the customer's
|
91
|
-
#
|
91
|
+
# saved payment method.
|
92
92
|
#
|
93
93
|
# @return [Boolean]
|
94
|
-
required :auto_collection, Orb::Internal::Type::
|
94
|
+
required :auto_collection, Orb::Internal::Type::Boolean
|
95
95
|
|
96
96
|
# @!attribute net_terms
|
97
97
|
# The net terms determines the difference between the invoice date and the issue
|
98
|
-
#
|
99
|
-
#
|
98
|
+
# date for the invoice. If you intend the invoice to be due on issue, set this
|
99
|
+
# to 0.
|
100
100
|
#
|
101
101
|
# @return [Integer]
|
102
102
|
required :net_terms, Integer
|
@@ -109,10 +109,10 @@ module Orb
|
|
109
109
|
|
110
110
|
# @!attribute [r] require_successful_payment
|
111
111
|
# If true, new credit blocks created by this top-up will require that the
|
112
|
-
#
|
112
|
+
# corresponding invoice is paid before they can be drawn down from.
|
113
113
|
#
|
114
114
|
# @return [Boolean, nil]
|
115
|
-
optional :require_successful_payment, Orb::Internal::Type::
|
115
|
+
optional :require_successful_payment, Orb::Internal::Type::Boolean
|
116
116
|
|
117
117
|
# @!parse
|
118
118
|
# # @return [Boolean]
|
@@ -19,7 +19,7 @@ module Orb
|
|
19
19
|
|
20
20
|
# @!attribute currency
|
21
21
|
# The currency or custom pricing unit to use for this top-up. If this is a
|
22
|
-
#
|
22
|
+
# real-world currency, it must match the customer's invoicing currency.
|
23
23
|
#
|
24
24
|
# @return [String]
|
25
25
|
required :currency, String
|
@@ -39,14 +39,14 @@ module Orb
|
|
39
39
|
|
40
40
|
# @!attribute threshold
|
41
41
|
# The threshold at which to trigger the top-up. If the balance is at or below this
|
42
|
-
#
|
42
|
+
# threshold, the top-up will be triggered.
|
43
43
|
#
|
44
44
|
# @return [String]
|
45
45
|
required :threshold, String
|
46
46
|
|
47
47
|
# @!attribute expires_after
|
48
48
|
# The number of days or months after which the top-up expires. If unspecified, it
|
49
|
-
#
|
49
|
+
# does not expire.
|
50
50
|
#
|
51
51
|
# @return [Integer, nil]
|
52
52
|
optional :expires_after, Integer, nil?: true
|
@@ -89,15 +89,15 @@ module Orb
|
|
89
89
|
class InvoiceSettings < Orb::Internal::Type::BaseModel
|
90
90
|
# @!attribute auto_collection
|
91
91
|
# Whether the credits purchase invoice should auto collect with the customer's
|
92
|
-
#
|
92
|
+
# saved payment method.
|
93
93
|
#
|
94
94
|
# @return [Boolean]
|
95
|
-
required :auto_collection, Orb::Internal::Type::
|
95
|
+
required :auto_collection, Orb::Internal::Type::Boolean
|
96
96
|
|
97
97
|
# @!attribute net_terms
|
98
98
|
# The net terms determines the difference between the invoice date and the issue
|
99
|
-
#
|
100
|
-
#
|
99
|
+
# date for the invoice. If you intend the invoice to be due on issue, set this
|
100
|
+
# to 0.
|
101
101
|
#
|
102
102
|
# @return [Integer]
|
103
103
|
required :net_terms, Integer
|
@@ -110,10 +110,10 @@ module Orb
|
|
110
110
|
|
111
111
|
# @!attribute [r] require_successful_payment
|
112
112
|
# If true, new credit blocks created by this top-up will require that the
|
113
|
-
#
|
113
|
+
# corresponding invoice is paid before they can be drawn down from.
|
114
114
|
#
|
115
115
|
# @return [Boolean, nil]
|
116
|
-
optional :require_successful_payment, Orb::Internal::Type::
|
116
|
+
optional :require_successful_payment, Orb::Internal::Type::Boolean
|
117
117
|
|
118
118
|
# @!parse
|
119
119
|
# # @return [Boolean]
|
@@ -19,7 +19,7 @@ module Orb
|
|
19
19
|
|
20
20
|
# @!attribute currency
|
21
21
|
# The currency or custom pricing unit to use for this top-up. If this is a
|
22
|
-
#
|
22
|
+
# real-world currency, it must match the customer's invoicing currency.
|
23
23
|
#
|
24
24
|
# @return [String]
|
25
25
|
required :currency, String
|
@@ -38,14 +38,14 @@ module Orb
|
|
38
38
|
|
39
39
|
# @!attribute threshold
|
40
40
|
# The threshold at which to trigger the top-up. If the balance is at or below this
|
41
|
-
#
|
41
|
+
# threshold, the top-up will be triggered.
|
42
42
|
#
|
43
43
|
# @return [String]
|
44
44
|
required :threshold, String
|
45
45
|
|
46
46
|
# @!attribute expires_after
|
47
47
|
# The number of days or months after which the top-up expires. If unspecified, it
|
48
|
-
#
|
48
|
+
# does not expire.
|
49
49
|
#
|
50
50
|
# @return [Integer, nil]
|
51
51
|
optional :expires_after, Integer, nil?: true
|
@@ -88,15 +88,15 @@ module Orb
|
|
88
88
|
class InvoiceSettings < Orb::Internal::Type::BaseModel
|
89
89
|
# @!attribute auto_collection
|
90
90
|
# Whether the credits purchase invoice should auto collect with the customer's
|
91
|
-
#
|
91
|
+
# saved payment method.
|
92
92
|
#
|
93
93
|
# @return [Boolean]
|
94
|
-
required :auto_collection, Orb::Internal::Type::
|
94
|
+
required :auto_collection, Orb::Internal::Type::Boolean
|
95
95
|
|
96
96
|
# @!attribute net_terms
|
97
97
|
# The net terms determines the difference between the invoice date and the issue
|
98
|
-
#
|
99
|
-
#
|
98
|
+
# date for the invoice. If you intend the invoice to be due on issue, set this
|
99
|
+
# to 0.
|
100
100
|
#
|
101
101
|
# @return [Integer]
|
102
102
|
required :net_terms, Integer
|
@@ -109,10 +109,10 @@ module Orb
|
|
109
109
|
|
110
110
|
# @!attribute [r] require_successful_payment
|
111
111
|
# If true, new credit blocks created by this top-up will require that the
|
112
|
-
#
|
112
|
+
# corresponding invoice is paid before they can be drawn down from.
|
113
113
|
#
|
114
114
|
# @return [Boolean, nil]
|
115
|
-
optional :require_successful_payment, Orb::Internal::Type::
|
115
|
+
optional :require_successful_payment, Orb::Internal::Type::Boolean
|
116
116
|
|
117
117
|
# @!parse
|
118
118
|
# # @return [Boolean]
|
@@ -11,8 +11,8 @@ module Orb
|
|
11
11
|
|
12
12
|
# @!attribute billable_metric_id
|
13
13
|
# The billable metric associated with this dimensional price group. All prices
|
14
|
-
#
|
15
|
-
#
|
14
|
+
# associated with this dimensional price group will be computed using this
|
15
|
+
# billable metric.
|
16
16
|
#
|
17
17
|
# @return [String]
|
18
18
|
required :billable_metric_id, String
|
@@ -31,9 +31,9 @@ module Orb
|
|
31
31
|
|
32
32
|
# @!attribute metadata
|
33
33
|
# User specified key-value pairs for the resource. If not present, this defaults
|
34
|
-
#
|
35
|
-
#
|
36
|
-
#
|
34
|
+
# to an empty dictionary. Individual keys can be removed by setting the value to
|
35
|
+
# `null`, and the entire metadata mapping can be cleared by setting `metadata` to
|
36
|
+
# `null`.
|
37
37
|
#
|
38
38
|
# @return [Hash{Symbol=>String}]
|
39
39
|
required :metadata, Orb::Internal::Type::HashOf[String]
|
@@ -46,8 +46,8 @@ module Orb
|
|
46
46
|
|
47
47
|
# @!parse
|
48
48
|
# # A dimensional price group is used to partition the result of a billable metric
|
49
|
-
# #
|
50
|
-
# #
|
49
|
+
# # by a set of dimensions. Prices in a price group must specify the parition used
|
50
|
+
# # to derive their usage.
|
51
51
|
# #
|
52
52
|
# # @param id [String]
|
53
53
|
# # @param billable_metric_id [String]
|