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
data/lib/orb/internal/util.rb
CHANGED
@@ -2,8 +2,6 @@
|
|
2
2
|
|
3
3
|
module Orb
|
4
4
|
module Internal
|
5
|
-
# rubocop:disable Metrics/ModuleLength
|
6
|
-
|
7
5
|
# @api private
|
8
6
|
module Util
|
9
7
|
# @api private
|
@@ -61,7 +59,7 @@ module Orb
|
|
61
59
|
# @return [Boolean]
|
62
60
|
def primitive?(input)
|
63
61
|
case input
|
64
|
-
in true | false |
|
62
|
+
in true | false | Numeric | Symbol | String
|
65
63
|
true
|
66
64
|
else
|
67
65
|
false
|
@@ -70,13 +68,11 @@ module Orb
|
|
70
68
|
|
71
69
|
# @api private
|
72
70
|
#
|
73
|
-
# @param input [
|
71
|
+
# @param input [String, Boolean]
|
74
72
|
#
|
75
73
|
# @return [Boolean, Object]
|
76
74
|
def coerce_boolean(input)
|
77
75
|
case input.is_a?(String) ? input.downcase : input
|
78
|
-
in Numeric
|
79
|
-
input.nonzero?
|
80
76
|
in "true"
|
81
77
|
true
|
82
78
|
in "false"
|
@@ -88,7 +84,7 @@ module Orb
|
|
88
84
|
|
89
85
|
# @api private
|
90
86
|
#
|
91
|
-
# @param input [
|
87
|
+
# @param input [String, Boolean]
|
92
88
|
#
|
93
89
|
# @raise [ArgumentError]
|
94
90
|
# @return [Boolean, nil]
|
@@ -103,34 +99,20 @@ module Orb
|
|
103
99
|
|
104
100
|
# @api private
|
105
101
|
#
|
106
|
-
# @param input [
|
102
|
+
# @param input [String, Integer]
|
107
103
|
#
|
108
104
|
# @return [Integer, Object]
|
109
105
|
def coerce_integer(input)
|
110
|
-
|
111
|
-
in true
|
112
|
-
1
|
113
|
-
in false
|
114
|
-
0
|
115
|
-
else
|
116
|
-
Integer(input, exception: false) || input
|
117
|
-
end
|
106
|
+
Integer(input, exception: false) || input
|
118
107
|
end
|
119
108
|
|
120
109
|
# @api private
|
121
110
|
#
|
122
|
-
# @param input [
|
111
|
+
# @param input [String, Integer, Float]
|
123
112
|
#
|
124
113
|
# @return [Float, Object]
|
125
114
|
def coerce_float(input)
|
126
|
-
|
127
|
-
in true
|
128
|
-
1.0
|
129
|
-
in false
|
130
|
-
0.0
|
131
|
-
else
|
132
|
-
Float(input, exception: false) || input
|
133
|
-
end
|
115
|
+
Float(input, exception: false) || input
|
134
116
|
end
|
135
117
|
|
136
118
|
# @api private
|
@@ -159,12 +141,7 @@ module Orb
|
|
159
141
|
private def deep_merge_lr(lhs, rhs, concat: false)
|
160
142
|
case [lhs, rhs, concat]
|
161
143
|
in [Hash, Hash, _]
|
162
|
-
|
163
|
-
lhs
|
164
|
-
.reject { |key, _| rhs[key] == Orb::Internal::OMIT }
|
165
|
-
.merge(rhs_cleaned) do |_, old_val, new_val|
|
166
|
-
deep_merge_lr(old_val, new_val, concat: concat)
|
167
|
-
end
|
144
|
+
lhs.merge(rhs) { deep_merge_lr(_2, _3, concat: concat) }
|
168
145
|
in [Array, Array, true]
|
169
146
|
lhs.concat(rhs)
|
170
147
|
else
|
@@ -175,7 +152,7 @@ module Orb
|
|
175
152
|
# @api private
|
176
153
|
#
|
177
154
|
# Recursively merge one hash with another. If the values at a given key are not
|
178
|
-
#
|
155
|
+
# both hashes, just take the new value.
|
179
156
|
#
|
180
157
|
# @param values [Array<Object>]
|
181
158
|
#
|
@@ -362,7 +339,7 @@ module Orb
|
|
362
339
|
value =
|
363
340
|
case val
|
364
341
|
in Array
|
365
|
-
val.
|
342
|
+
val.filter_map { _1&.to_s&.strip }.join(", ")
|
366
343
|
else
|
367
344
|
val&.to_s&.strip
|
368
345
|
end
|
@@ -419,7 +396,7 @@ module Orb
|
|
419
396
|
|
420
397
|
# @api private
|
421
398
|
#
|
422
|
-
# @param stream [String, IO, StringIO, Enumerable]
|
399
|
+
# @param stream [String, IO, StringIO, Enumerable<String>]
|
423
400
|
# @param blk [Proc]
|
424
401
|
#
|
425
402
|
# @yieldparam [String]
|
@@ -434,7 +411,7 @@ module Orb
|
|
434
411
|
# @param blk [Proc]
|
435
412
|
#
|
436
413
|
# @yieldparam [Enumerator::Yielder]
|
437
|
-
# @return [Enumerable]
|
414
|
+
# @return [Enumerable<String>]
|
438
415
|
def writable_enum(&blk)
|
439
416
|
Enumerator.new do |y|
|
440
417
|
y.define_singleton_method(:write) do
|
@@ -469,7 +446,7 @@ module Orb
|
|
469
446
|
case val
|
470
447
|
in IO
|
471
448
|
y << "Content-Type: application/octet-stream\r\n\r\n"
|
472
|
-
IO.copy_stream(val, y)
|
449
|
+
IO.copy_stream(val.tap(&:rewind), y)
|
473
450
|
in StringIO
|
474
451
|
y << "Content-Type: application/octet-stream\r\n\r\n"
|
475
452
|
y << val.string
|
@@ -490,7 +467,7 @@ module Orb
|
|
490
467
|
#
|
491
468
|
# @param body [Object]
|
492
469
|
#
|
493
|
-
# @return [Array(String, Enumerable)]
|
470
|
+
# @return [Array(String, Enumerable<String>)]
|
494
471
|
private def encode_multipart_streaming(body)
|
495
472
|
boundary = SecureRandom.urlsafe_base64(60)
|
496
473
|
|
@@ -525,7 +502,7 @@ module Orb
|
|
525
502
|
def encode_content(headers, body)
|
526
503
|
content_type = headers["content-type"]
|
527
504
|
case [content_type, body]
|
528
|
-
in [%r{^application/(?:vnd\.api\+)?json},
|
505
|
+
in [%r{^application/(?:vnd\.api\+)?json}, _] unless body.nil?
|
529
506
|
[headers, JSON.fast_generate(body)]
|
530
507
|
in [%r{^application/(?:x-)?jsonl}, Enumerable]
|
531
508
|
[headers, body.lazy.map { JSON.fast_generate(_1) }]
|
@@ -533,8 +510,12 @@ module Orb
|
|
533
510
|
boundary, strio = encode_multipart_streaming(body)
|
534
511
|
headers = {**headers, "content-type" => "#{content_type}; boundary=#{boundary}"}
|
535
512
|
[headers, strio]
|
513
|
+
in [_, IO]
|
514
|
+
[headers, body.tap(&:rewind)]
|
536
515
|
in [_, StringIO]
|
537
516
|
[headers, body.string]
|
517
|
+
in [_, Symbol | Numeric]
|
518
|
+
[headers, body.to_s]
|
538
519
|
else
|
539
520
|
[headers, body]
|
540
521
|
end
|
@@ -543,7 +524,7 @@ module Orb
|
|
543
524
|
# @api private
|
544
525
|
#
|
545
526
|
# @param headers [Hash{String=>String}, Net::HTTPHeader]
|
546
|
-
# @param stream [Enumerable]
|
527
|
+
# @param stream [Enumerable<String>]
|
547
528
|
# @param suppress_error [Boolean]
|
548
529
|
#
|
549
530
|
# @raise [JSON::ParserError]
|
@@ -580,11 +561,11 @@ module Orb
|
|
580
561
|
#
|
581
562
|
# https://doc.rust-lang.org/std/iter/trait.FusedIterator.html
|
582
563
|
#
|
583
|
-
# @param enum [Enumerable]
|
564
|
+
# @param enum [Enumerable<Object>]
|
584
565
|
# @param external [Boolean]
|
585
566
|
# @param close [Proc]
|
586
567
|
#
|
587
|
-
# @return [Enumerable]
|
568
|
+
# @return [Enumerable<Object>]
|
588
569
|
def fused_enum(enum, external: false, &close)
|
589
570
|
fused = false
|
590
571
|
iter = Enumerator.new do |y|
|
@@ -610,7 +591,7 @@ module Orb
|
|
610
591
|
|
611
592
|
# @api private
|
612
593
|
#
|
613
|
-
# @param enum [Enumerable
|
594
|
+
# @param enum [Enumerable<Object>, nil]
|
614
595
|
def close_fused!(enum)
|
615
596
|
return unless enum.is_a?(Enumerator)
|
616
597
|
|
@@ -621,11 +602,11 @@ module Orb
|
|
621
602
|
|
622
603
|
# @api private
|
623
604
|
#
|
624
|
-
# @param enum [Enumerable
|
605
|
+
# @param enum [Enumerable<Object>, nil]
|
625
606
|
# @param blk [Proc]
|
626
607
|
#
|
627
608
|
# @yieldparam [Enumerator::Yielder]
|
628
|
-
# @return [Enumerable]
|
609
|
+
# @return [Enumerable<Object>]
|
629
610
|
def chain_fused(enum, &blk)
|
630
611
|
iter = Enumerator.new { blk.call(_1) }
|
631
612
|
fused_enum(iter) { close_fused!(enum) }
|
@@ -635,9 +616,9 @@ module Orb
|
|
635
616
|
class << self
|
636
617
|
# @api private
|
637
618
|
#
|
638
|
-
# @param enum [Enumerable]
|
619
|
+
# @param enum [Enumerable<String>]
|
639
620
|
#
|
640
|
-
# @return [Enumerable]
|
621
|
+
# @return [Enumerable<String>]
|
641
622
|
def decode_lines(enum)
|
642
623
|
re = /(\r\n|\r|\n)/
|
643
624
|
buffer = String.new.b
|
@@ -671,9 +652,9 @@ module Orb
|
|
671
652
|
#
|
672
653
|
# https://html.spec.whatwg.org/multipage/server-sent-events.html#parsing-an-event-stream
|
673
654
|
#
|
674
|
-
# @param lines [Enumerable]
|
655
|
+
# @param lines [Enumerable<String>]
|
675
656
|
#
|
676
|
-
# @return [Hash{Symbol=>Object}]
|
657
|
+
# @return [Enumerable<Hash{Symbol=>Object}>]
|
677
658
|
def decode_sse(lines)
|
678
659
|
# rubocop:disable Metrics/BlockLength
|
679
660
|
chain_fused(lines) do |y|
|
@@ -711,7 +692,5 @@ module Orb
|
|
711
692
|
end
|
712
693
|
end
|
713
694
|
end
|
714
|
-
|
715
|
-
# rubocop:enable Metrics/ModuleLength
|
716
695
|
end
|
717
696
|
end
|
data/lib/orb/models/alert.rb
CHANGED
@@ -32,7 +32,7 @@ module Orb
|
|
32
32
|
# Whether the alert is enabled or disabled.
|
33
33
|
#
|
34
34
|
# @return [Boolean]
|
35
|
-
required :enabled, Orb::Internal::Type::
|
35
|
+
required :enabled, Orb::Internal::Type::Boolean
|
36
36
|
|
37
37
|
# @!attribute metric
|
38
38
|
# The metric the alert applies to.
|
@@ -54,7 +54,7 @@ module Orb
|
|
54
54
|
|
55
55
|
# @!attribute thresholds
|
56
56
|
# The thresholds that define the conditions under which the alert will be
|
57
|
-
#
|
57
|
+
# triggered.
|
58
58
|
#
|
59
59
|
# @return [Array<Orb::Models::Alert::Threshold>, nil]
|
60
60
|
required :thresholds, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Alert::Threshold] }, nil?: true
|
@@ -67,10 +67,10 @@ module Orb
|
|
67
67
|
|
68
68
|
# @!parse
|
69
69
|
# # [Alerts within Orb](/product-catalog/configuring-alerts) monitor spending,
|
70
|
-
# #
|
70
|
+
# # usage, or credit balance and trigger webhooks when a threshold is exceeded.
|
71
71
|
# #
|
72
|
-
# #
|
73
|
-
# #
|
72
|
+
# # Alerts created through the API can be scoped to either customers or
|
73
|
+
# # subscriptions.
|
74
74
|
# #
|
75
75
|
# # @param id [String]
|
76
76
|
# # @param created_at [Time]
|
@@ -136,8 +136,8 @@ module Orb
|
|
136
136
|
|
137
137
|
# @!attribute external_plan_id
|
138
138
|
# An optional user-defined ID for this plan resource, used throughout the system
|
139
|
-
#
|
140
|
-
#
|
139
|
+
# as an alias for this Plan. Use this field to identify a plan by an existing
|
140
|
+
# identifier in your system.
|
141
141
|
#
|
142
142
|
# @return [String, nil]
|
143
143
|
required :external_plan_id, String, nil?: true
|
@@ -185,15 +185,15 @@ module Orb
|
|
185
185
|
class Threshold < Orb::Internal::Type::BaseModel
|
186
186
|
# @!attribute value
|
187
187
|
# The value at which an alert will fire. For credit balance alerts, the alert will
|
188
|
-
#
|
189
|
-
#
|
188
|
+
# fire at or below this value. For usage and cost alerts, the alert will fire at
|
189
|
+
# or above this value.
|
190
190
|
#
|
191
191
|
# @return [Float]
|
192
192
|
required :value, Float
|
193
193
|
|
194
194
|
# @!parse
|
195
195
|
# # Thresholds are used to define the conditions under which an alert will be
|
196
|
-
# #
|
196
|
+
# # triggered.
|
197
197
|
# #
|
198
198
|
# # @param value [Float]
|
199
199
|
# #
|
@@ -56,15 +56,15 @@ module Orb
|
|
56
56
|
class Threshold < Orb::Internal::Type::BaseModel
|
57
57
|
# @!attribute value
|
58
58
|
# The value at which an alert will fire. For credit balance alerts, the alert will
|
59
|
-
#
|
60
|
-
#
|
59
|
+
# fire at or below this value. For usage and cost alerts, the alert will fire at
|
60
|
+
# or above this value.
|
61
61
|
#
|
62
62
|
# @return [Float]
|
63
63
|
required :value, Float
|
64
64
|
|
65
65
|
# @!parse
|
66
66
|
# # Thresholds are used to define the conditions under which an alert will be
|
67
|
-
# #
|
67
|
+
# # triggered.
|
68
68
|
# #
|
69
69
|
# # @param value [Float]
|
70
70
|
# #
|
@@ -56,15 +56,15 @@ module Orb
|
|
56
56
|
class Threshold < Orb::Internal::Type::BaseModel
|
57
57
|
# @!attribute value
|
58
58
|
# The value at which an alert will fire. For credit balance alerts, the alert will
|
59
|
-
#
|
60
|
-
#
|
59
|
+
# fire at or below this value. For usage and cost alerts, the alert will fire at
|
60
|
+
# or above this value.
|
61
61
|
#
|
62
62
|
# @return [Float]
|
63
63
|
required :value, Float
|
64
64
|
|
65
65
|
# @!parse
|
66
66
|
# # Thresholds are used to define the conditions under which an alert will be
|
67
|
-
# #
|
67
|
+
# # triggered.
|
68
68
|
# #
|
69
69
|
# # @param value [Float]
|
70
70
|
# #
|
@@ -40,15 +40,15 @@ module Orb
|
|
40
40
|
class Threshold < Orb::Internal::Type::BaseModel
|
41
41
|
# @!attribute value
|
42
42
|
# The value at which an alert will fire. For credit balance alerts, the alert will
|
43
|
-
#
|
44
|
-
#
|
43
|
+
# fire at or below this value. For usage and cost alerts, the alert will fire at
|
44
|
+
# or above this value.
|
45
45
|
#
|
46
46
|
# @return [Float]
|
47
47
|
required :value, Float
|
48
48
|
|
49
49
|
# @!parse
|
50
50
|
# # Thresholds are used to define the conditions under which an alert will be
|
51
|
-
# #
|
51
|
+
# # triggered.
|
52
52
|
# #
|
53
53
|
# # @param value [Float]
|
54
54
|
# #
|
@@ -11,26 +11,26 @@ module Orb
|
|
11
11
|
# @!attribute created_at_gt
|
12
12
|
#
|
13
13
|
# @return [Time, nil]
|
14
|
-
optional :created_at_gt, Time,
|
14
|
+
optional :created_at_gt, Time, nil?: true
|
15
15
|
|
16
16
|
# @!attribute created_at_gte
|
17
17
|
#
|
18
18
|
# @return [Time, nil]
|
19
|
-
optional :created_at_gte, Time,
|
19
|
+
optional :created_at_gte, Time, nil?: true
|
20
20
|
|
21
21
|
# @!attribute created_at_lt
|
22
22
|
#
|
23
23
|
# @return [Time, nil]
|
24
|
-
optional :created_at_lt, Time,
|
24
|
+
optional :created_at_lt, Time, nil?: true
|
25
25
|
|
26
26
|
# @!attribute created_at_lte
|
27
27
|
#
|
28
28
|
# @return [Time, nil]
|
29
|
-
optional :created_at_lte, Time,
|
29
|
+
optional :created_at_lte, Time, nil?: true
|
30
30
|
|
31
31
|
# @!attribute cursor
|
32
32
|
# Cursor for pagination. This can be populated by the `next_cursor` value returned
|
33
|
-
#
|
33
|
+
# from the initial request.
|
34
34
|
#
|
35
35
|
# @return [String, nil]
|
36
36
|
optional :cursor, String, nil?: true
|
@@ -25,15 +25,15 @@ module Orb
|
|
25
25
|
class Threshold < Orb::Internal::Type::BaseModel
|
26
26
|
# @!attribute value
|
27
27
|
# The value at which an alert will fire. For credit balance alerts, the alert will
|
28
|
-
#
|
29
|
-
#
|
28
|
+
# fire at or below this value. For usage and cost alerts, the alert will fire at
|
29
|
+
# or above this value.
|
30
30
|
#
|
31
31
|
# @return [Float]
|
32
32
|
required :value, Float
|
33
33
|
|
34
34
|
# @!parse
|
35
35
|
# # Thresholds are used to define the conditions under which an alert will be
|
36
|
-
# #
|
36
|
+
# # triggered.
|
37
37
|
# #
|
38
38
|
# # @param value [Float]
|
39
39
|
# #
|
@@ -11,7 +11,7 @@ module Orb
|
|
11
11
|
|
12
12
|
# @!attribute applies_to_price_ids
|
13
13
|
# List of price_ids that this discount applies to. For plan/plan phase discounts,
|
14
|
-
#
|
14
|
+
# this can be a subset of prices.
|
15
15
|
#
|
16
16
|
# @return [Array<String>]
|
17
17
|
required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
|
@@ -16,17 +16,17 @@ module Orb
|
|
16
16
|
|
17
17
|
# @!attribute item
|
18
18
|
# The Item resource represents a sellable product or good. Items are associated
|
19
|
-
#
|
20
|
-
#
|
19
|
+
# with all line items, billable metrics, and prices and are used for defining
|
20
|
+
# external sync behavior for invoices and tax calculation purposes.
|
21
21
|
#
|
22
22
|
# @return [Orb::Models::Item]
|
23
23
|
required :item, -> { Orb::Models::Item }
|
24
24
|
|
25
25
|
# @!attribute metadata
|
26
26
|
# User specified key-value pairs for the resource. If not present, this defaults
|
27
|
-
#
|
28
|
-
#
|
29
|
-
#
|
27
|
+
# to an empty dictionary. Individual keys can be removed by setting the value to
|
28
|
+
# `null`, and the entire metadata mapping can be cleared by setting `metadata` to
|
29
|
+
# `null`.
|
30
30
|
#
|
31
31
|
# @return [Hash{Symbol=>String}]
|
32
32
|
required :metadata, Orb::Internal::Type::HashOf[String]
|
@@ -43,8 +43,8 @@ module Orb
|
|
43
43
|
|
44
44
|
# @!parse
|
45
45
|
# # The Metric resource represents a calculation of a quantity based on events.
|
46
|
-
# #
|
47
|
-
# #
|
46
|
+
# # Metrics are defined by the query that transforms raw usage events into
|
47
|
+
# # meaningful values for your customers.
|
48
48
|
# #
|
49
49
|
# # @param id [String]
|
50
50
|
# # @param description [String, nil]
|
data/lib/orb/models/coupon.rb
CHANGED
@@ -12,7 +12,7 @@ module Orb
|
|
12
12
|
|
13
13
|
# @!attribute archived_at
|
14
14
|
# An archived coupon can no longer be redeemed. Active coupons will have a value
|
15
|
-
#
|
15
|
+
# of null for `archived_at`; this field will be non-null for archived coupons.
|
16
16
|
#
|
17
17
|
# @return [Time, nil]
|
18
18
|
required :archived_at, Time, nil?: true
|
@@ -24,14 +24,14 @@ module Orb
|
|
24
24
|
|
25
25
|
# @!attribute duration_in_months
|
26
26
|
# This allows for a coupon's discount to apply for a limited time (determined in
|
27
|
-
#
|
27
|
+
# months); a `null` value here means "unlimited time".
|
28
28
|
#
|
29
29
|
# @return [Integer, nil]
|
30
30
|
required :duration_in_months, Integer, nil?: true
|
31
31
|
|
32
32
|
# @!attribute max_redemptions
|
33
33
|
# The maximum number of redemptions allowed for this coupon before it is
|
34
|
-
#
|
34
|
+
# exhausted; `null` here means "unlimited".
|
35
35
|
#
|
36
36
|
# @return [Integer, nil]
|
37
37
|
required :max_redemptions, Integer, nil?: true
|
@@ -50,10 +50,10 @@ module Orb
|
|
50
50
|
|
51
51
|
# @!parse
|
52
52
|
# # A coupon represents a reusable discount configuration that can be applied either
|
53
|
-
# #
|
54
|
-
# #
|
55
|
-
# #
|
56
|
-
# #
|
53
|
+
# # as a fixed or percentage amount to an invoice or subscription. Coupons are
|
54
|
+
# # activated using a redemption code, which applies the discount to a subscription
|
55
|
+
# # or invoice. The duration of a coupon determines how long it remains available
|
56
|
+
# # for use by end users.
|
57
57
|
# #
|
58
58
|
# # @param id [String]
|
59
59
|
# # @param archived_at [Time, nil]
|
@@ -21,14 +21,14 @@ module Orb
|
|
21
21
|
|
22
22
|
# @!attribute duration_in_months
|
23
23
|
# This allows for a coupon's discount to apply for a limited time (determined in
|
24
|
-
#
|
24
|
+
# months); a `null` value here means "unlimited time".
|
25
25
|
#
|
26
26
|
# @return [Integer, nil]
|
27
27
|
optional :duration_in_months, Integer, nil?: true
|
28
28
|
|
29
29
|
# @!attribute max_redemptions
|
30
30
|
# The maximum number of redemptions allowed for this coupon before it is
|
31
|
-
#
|
31
|
+
# exhausted;`null` here means "unlimited".
|
32
32
|
#
|
33
33
|
# @return [Integer, nil]
|
34
34
|
optional :max_redemptions, Integer, nil?: true
|
@@ -10,7 +10,7 @@ module Orb
|
|
10
10
|
|
11
11
|
# @!attribute cursor
|
12
12
|
# Cursor for pagination. This can be populated by the `next_cursor` value returned
|
13
|
-
#
|
13
|
+
# from the initial request.
|
14
14
|
#
|
15
15
|
# @return [String, nil]
|
16
16
|
optional :cursor, String, nil?: true
|
@@ -33,10 +33,10 @@ module Orb
|
|
33
33
|
|
34
34
|
# @!attribute show_archived
|
35
35
|
# Show archived coupons as well (by default, this endpoint only returns active
|
36
|
-
#
|
36
|
+
# coupons).
|
37
37
|
#
|
38
38
|
# @return [Boolean, nil]
|
39
|
-
optional :show_archived, Orb::Internal::Type::
|
39
|
+
optional :show_archived, Orb::Internal::Type::Boolean, nil?: true
|
40
40
|
|
41
41
|
# @!parse
|
42
42
|
# # @param cursor [String, nil]
|
@@ -103,7 +103,7 @@ module Orb
|
|
103
103
|
|
104
104
|
# @!parse
|
105
105
|
# # The [Credit Note](/invoicing/credit-notes) resource represents a credit that has
|
106
|
-
# #
|
106
|
+
# # been applied to a particular invoice.
|
107
107
|
# #
|
108
108
|
# # @param id [String]
|
109
109
|
# # @param created_at [Time]
|
@@ -11,26 +11,26 @@ module Orb
|
|
11
11
|
# @!attribute created_at_gt
|
12
12
|
#
|
13
13
|
# @return [Time, nil]
|
14
|
-
optional :created_at_gt, Time,
|
14
|
+
optional :created_at_gt, Time, nil?: true
|
15
15
|
|
16
16
|
# @!attribute created_at_gte
|
17
17
|
#
|
18
18
|
# @return [Time, nil]
|
19
|
-
optional :created_at_gte, Time,
|
19
|
+
optional :created_at_gte, Time, nil?: true
|
20
20
|
|
21
21
|
# @!attribute created_at_lt
|
22
22
|
#
|
23
23
|
# @return [Time, nil]
|
24
|
-
optional :created_at_lt, Time,
|
24
|
+
optional :created_at_lt, Time, nil?: true
|
25
25
|
|
26
26
|
# @!attribute created_at_lte
|
27
27
|
#
|
28
28
|
# @return [Time, nil]
|
29
|
-
optional :created_at_lte, Time,
|
29
|
+
optional :created_at_lte, Time, nil?: true
|
30
30
|
|
31
31
|
# @!attribute cursor
|
32
32
|
# Cursor for pagination. This can be populated by the `next_cursor` value returned
|
33
|
-
#
|
33
|
+
# from the initial request.
|
34
34
|
#
|
35
35
|
# @return [String, nil]
|
36
36
|
optional :cursor, String, nil?: true
|