orb-billing 0.3.0 → 0.3.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +47 -0
- data/README.md +7 -7
- data/lib/orb/errors.rb +9 -9
- data/lib/orb/file_part.rb +2 -2
- data/lib/orb/internal/page.rb +3 -3
- data/lib/orb/internal/transport/base_client.rb +3 -3
- data/lib/orb/internal/type/base_model.rb +1 -9
- data/lib/orb/internal/type/boolean.rb +10 -11
- data/lib/orb/internal/type/enum.rb +13 -14
- data/lib/orb/internal/type/request_parameters.rb +6 -12
- data/lib/orb/internal/type/union.rb +4 -4
- data/lib/orb/internal/type/unknown.rb +10 -11
- data/lib/orb/internal/util.rb +21 -5
- data/lib/orb/models/alert.rb +29 -32
- data/lib/orb/models/alert_create_for_customer_params.rb +7 -8
- data/lib/orb/models/alert_create_for_external_customer_params.rb +7 -8
- data/lib/orb/models/alert_create_for_subscription_params.rb +7 -8
- data/lib/orb/models/alert_list_params.rb +0 -1
- data/lib/orb/models/alert_update_params.rb +4 -5
- data/lib/orb/models/amount_discount.rb +6 -7
- data/lib/orb/models/billable_metric.rb +9 -11
- data/lib/orb/models/coupon.rb +9 -12
- data/lib/orb/models/coupon_create_params.rb +8 -10
- data/lib/orb/models/coupon_list_params.rb +0 -2
- data/lib/orb/models/coupons/subscription_list_params.rb +0 -1
- data/lib/orb/models/credit_note.rb +48 -46
- data/lib/orb/models/credit_note_create_params.rb +6 -6
- data/lib/orb/models/credit_note_list_params.rb +0 -1
- data/lib/orb/models/customer.rb +54 -61
- data/lib/orb/models/customer_create_params.rb +43 -55
- data/lib/orb/models/customer_list_params.rb +0 -1
- data/lib/orb/models/customer_update_by_external_id_params.rb +43 -57
- data/lib/orb/models/customer_update_params.rb +43 -53
- data/lib/orb/models/customers/balance_transaction_create_params.rb +3 -3
- data/lib/orb/models/customers/balance_transaction_create_response.rb +0 -2
- data/lib/orb/models/customers/balance_transaction_list_params.rb +0 -1
- data/lib/orb/models/customers/balance_transaction_list_response.rb +0 -2
- data/lib/orb/models/customers/cost_list_by_external_id_params.rb +3 -4
- data/lib/orb/models/customers/cost_list_by_external_id_response.rb +3 -3
- data/lib/orb/models/customers/cost_list_params.rb +3 -4
- data/lib/orb/models/customers/cost_list_response.rb +3 -3
- data/lib/orb/models/customers/credit_list_by_external_id_params.rb +0 -2
- data/lib/orb/models/customers/credit_list_params.rb +0 -2
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +12 -21
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +106 -114
- data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +11 -22
- data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +111 -126
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +6 -7
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +110 -121
- data/lib/orb/models/customers/credits/ledger_list_params.rb +8 -9
- data/lib/orb/models/customers/credits/ledger_list_response.rb +112 -131
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +10 -15
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +0 -6
- data/lib/orb/models/customers/credits/top_up_create_params.rb +7 -15
- data/lib/orb/models/customers/credits/top_up_create_response.rb +0 -6
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +0 -1
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +0 -6
- data/lib/orb/models/customers/credits/top_up_list_params.rb +0 -1
- data/lib/orb/models/customers/credits/top_up_list_response.rb +0 -6
- data/lib/orb/models/dimensional_price_group.rb +1 -3
- data/lib/orb/models/dimensional_price_group_create_params.rb +0 -1
- data/lib/orb/models/dimensional_price_group_list_params.rb +0 -1
- data/lib/orb/models/dimensional_price_groups.rb +6 -6
- data/lib/orb/models/discount.rb +5 -5
- data/lib/orb/models/evaluate_price_group.rb +1 -1
- data/lib/orb/models/event_ingest_params.rb +4 -9
- data/lib/orb/models/event_ingest_response.rb +0 -3
- data/lib/orb/models/event_search_params.rb +0 -3
- data/lib/orb/models/event_search_response.rb +0 -4
- data/lib/orb/models/event_update_params.rb +0 -3
- data/lib/orb/models/events/backfill_close_response.rb +0 -4
- data/lib/orb/models/events/backfill_create_params.rb +0 -7
- data/lib/orb/models/events/backfill_create_response.rb +0 -4
- data/lib/orb/models/events/backfill_fetch_response.rb +0 -4
- data/lib/orb/models/events/backfill_list_params.rb +0 -1
- data/lib/orb/models/events/backfill_list_response.rb +0 -4
- data/lib/orb/models/events/backfill_revert_response.rb +0 -4
- data/lib/orb/models/events/event_volumes.rb +3 -3
- data/lib/orb/models/events/volume_list_params.rb +0 -3
- data/lib/orb/models/invoice.rb +165 -224
- data/lib/orb/models/invoice_create_params.rb +14 -21
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +58 -107
- data/lib/orb/models/invoice_issue_params.rb +0 -1
- data/lib/orb/models/invoice_level_discount.rb +4 -4
- data/lib/orb/models/invoice_line_item_create_params.rb +0 -1
- data/lib/orb/models/invoice_line_item_create_response.rb +58 -81
- data/lib/orb/models/invoice_list_params.rb +6 -10
- data/lib/orb/models/invoice_update_params.rb +0 -1
- data/lib/orb/models/item.rb +7 -8
- data/lib/orb/models/item_list_params.rb +0 -1
- data/lib/orb/models/item_update_params.rb +7 -7
- data/lib/orb/models/metric_create_params.rb +0 -1
- data/lib/orb/models/metric_list_params.rb +0 -1
- data/lib/orb/models/metric_update_params.rb +0 -1
- data/lib/orb/models/percentage_discount.rb +6 -8
- data/lib/orb/models/plan.rb +83 -111
- data/lib/orb/models/plan_create_params.rb +753 -861
- data/lib/orb/models/plan_list_params.rb +3 -4
- data/lib/orb/models/plan_update_params.rb +0 -2
- data/lib/orb/models/plans/external_plan_id_update_params.rb +0 -2
- data/lib/orb/models/price.rb +1699 -1804
- data/lib/orb/models/price_create_params.rb +75 -84
- data/lib/orb/models/price_evaluate_params.rb +0 -2
- data/lib/orb/models/price_evaluate_response.rb +3 -3
- data/lib/orb/models/price_list_params.rb +0 -1
- data/lib/orb/models/price_update_params.rb +0 -1
- data/lib/orb/models/prices/external_price_id_update_params.rb +0 -1
- data/lib/orb/models/subscription.rb +94 -136
- data/lib/orb/models/subscription_cancel_params.rb +3 -5
- data/lib/orb/models/subscription_cancel_response.rb +52 -91
- data/lib/orb/models/subscription_change_apply_response.rb +50 -88
- data/lib/orb/models/subscription_change_cancel_response.rb +50 -87
- data/lib/orb/models/subscription_change_retrieve_response.rb +50 -87
- data/lib/orb/models/subscription_create_params.rb +1927 -1928
- data/lib/orb/models/subscription_create_response.rb +52 -91
- data/lib/orb/models/subscription_fetch_costs_params.rb +3 -4
- data/lib/orb/models/subscription_fetch_costs_response.rb +3 -3
- data/lib/orb/models/subscription_fetch_schedule_params.rb +0 -1
- data/lib/orb/models/subscription_fetch_schedule_response.rb +0 -1
- data/lib/orb/models/subscription_fetch_usage_params.rb +6 -8
- data/lib/orb/models/subscription_list_params.rb +3 -4
- data/lib/orb/models/subscription_price_intervals_params.rb +1141 -1079
- data/lib/orb/models/subscription_price_intervals_response.rb +51 -90
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +1966 -1906
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +50 -88
- data/lib/orb/models/subscription_trigger_phase_params.rb +0 -2
- data/lib/orb/models/subscription_trigger_phase_response.rb +51 -90
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +50 -88
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +50 -86
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +50 -86
- data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +3 -6
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +50 -88
- data/lib/orb/models/subscription_update_params.rb +0 -5
- data/lib/orb/models/subscription_update_trial_params.rb +4 -6
- data/lib/orb/models/subscription_update_trial_response.rb +52 -91
- data/lib/orb/models/subscription_usage.rb +46 -39
- data/lib/orb/models/subscriptions.rb +6 -6
- data/lib/orb/models/trial_discount.rb +6 -7
- data/lib/orb/models/usage_discount.rb +6 -8
- data/lib/orb/models.rb +220 -0
- data/lib/orb/request_options.rb +4 -5
- data/lib/orb/resources/alerts.rb +30 -31
- data/lib/orb/resources/coupons/subscriptions.rb +3 -4
- data/lib/orb/resources/coupons.rb +11 -21
- data/lib/orb/resources/credit_notes.rb +10 -11
- data/lib/orb/resources/customers/balance_transactions.rb +3 -4
- data/lib/orb/resources/customers/costs.rb +4 -6
- data/lib/orb/resources/customers/credits/ledger.rb +18 -37
- data/lib/orb/resources/customers/credits/top_ups.rb +10 -20
- data/lib/orb/resources/customers/credits.rb +2 -6
- data/lib/orb/resources/customers.rb +40 -67
- data/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rb +2 -2
- data/lib/orb/resources/dimensional_price_groups.rb +8 -10
- data/lib/orb/resources/events/backfills.rb +2 -10
- data/lib/orb/resources/events/volume.rb +3 -6
- data/lib/orb/resources/events.rb +4 -12
- data/lib/orb/resources/invoice_line_items.rb +1 -2
- data/lib/orb/resources/invoices.rb +26 -43
- data/lib/orb/resources/items.rb +12 -13
- data/lib/orb/resources/metrics.rb +11 -14
- data/lib/orb/resources/plans/external_plan_id.rb +5 -7
- data/lib/orb/resources/plans.rb +14 -23
- data/lib/orb/resources/prices/external_price_id.rb +5 -6
- data/lib/orb/resources/prices.rb +25 -35
- data/lib/orb/resources/subscription_changes.rb +1 -1
- data/lib/orb/resources/subscriptions.rb +49 -107
- data/lib/orb/version.rb +1 -1
- data/lib/orb.rb +1 -0
- data/rbi/{lib/orb → orb}/client.rbi +5 -4
- data/rbi/{lib/orb → orb}/errors.rbi +58 -27
- data/rbi/{lib/orb → orb}/file_part.rbi +9 -6
- data/rbi/{lib/orb → orb}/internal/page.rbi +19 -6
- data/rbi/{lib/orb → orb}/internal/transport/base_client.rbi +131 -73
- data/rbi/{lib/orb → orb}/internal/transport/pooled_net_requester.rbi +25 -12
- data/rbi/orb/internal/type/array_of.rbi +98 -0
- data/rbi/{lib/orb → orb}/internal/type/base_model.rbi +124 -65
- data/rbi/{lib/orb → orb}/internal/type/base_page.rbi +11 -7
- data/rbi/{lib/orb → orb}/internal/type/boolean.rbi +16 -10
- data/rbi/{lib/orb → orb}/internal/type/converter.rbi +66 -31
- data/rbi/{lib/orb → orb}/internal/type/enum.rbi +27 -15
- data/rbi/{lib/orb → orb}/internal/type/file_input.rbi +12 -10
- data/rbi/{lib/orb → orb}/internal/type/hash_of.rbi +34 -24
- data/rbi/orb/internal/type/request_parameters.rbi +29 -0
- data/rbi/orb/internal/type/union.rbi +110 -0
- data/rbi/orb/internal/type/unknown.rbi +50 -0
- data/rbi/orb/internal/util.rbi +424 -0
- data/rbi/{lib/orb → orb}/models/alert.rbi +107 -70
- data/rbi/{lib/orb → orb}/models/alert_create_for_customer_params.rbi +60 -27
- data/rbi/{lib/orb → orb}/models/alert_create_for_external_customer_params.rbi +68 -29
- data/rbi/{lib/orb → orb}/models/alert_create_for_subscription_params.rbi +53 -26
- data/rbi/{lib/orb → orb}/models/alert_disable_params.rbi +17 -6
- data/rbi/{lib/orb → orb}/models/alert_enable_params.rbi +17 -6
- data/rbi/{lib/orb → orb}/models/alert_list_params.rbi +23 -20
- data/rbi/orb/models/alert_retrieve_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/alert_update_params.rbi +25 -14
- data/rbi/{lib/orb → orb}/models/amount_discount.rbi +28 -19
- data/rbi/{lib/orb → orb}/models/billable_metric.rbi +33 -26
- data/rbi/orb/models/billing_cycle_relative_date.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/coupon.rbi +28 -20
- data/rbi/orb/models/coupon_archive_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/coupon_create_params.rbi +74 -40
- data/rbi/orb/models/coupon_fetch_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/coupon_list_params.rbi +18 -15
- data/rbi/{lib/orb → orb}/models/coupons/subscription_list_params.rbi +16 -6
- data/rbi/{lib/orb → orb}/models/credit_note.rbi +293 -158
- data/rbi/orb/models/credit_note_create_params.rbi +117 -0
- data/rbi/orb/models/credit_note_fetch_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/credit_note_list_params.rbi +20 -17
- data/rbi/{lib/orb → orb}/models/customer.rbi +430 -329
- data/rbi/{lib/orb → orb}/models/customer_create_params.rbi +664 -327
- data/rbi/orb/models/customer_delete_params.rbi +24 -0
- data/rbi/orb/models/customer_fetch_by_external_id_params.rbi +24 -0
- data/rbi/orb/models/customer_fetch_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/customer_list_params.rbi +20 -17
- data/rbi/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +24 -0
- data/rbi/orb/models/customer_sync_payment_methods_from_gateway_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/customer_update_by_external_id_params.rbi +1138 -338
- data/rbi/{lib/orb → orb}/models/customer_update_params.rbi +663 -326
- data/rbi/orb/models/customers/balance_transaction_create_params.rbi +94 -0
- data/rbi/orb/models/customers/balance_transaction_create_response.rbi +301 -0
- data/rbi/{lib/orb → orb}/models/customers/balance_transaction_list_params.rbi +20 -17
- data/rbi/orb/models/customers/balance_transaction_list_response.rbi +301 -0
- data/rbi/{lib/orb → orb}/models/customers/cost_list_by_external_id_params.rbi +56 -22
- data/rbi/orb/models/customers/cost_list_by_external_id_response.rbi +263 -0
- data/rbi/{lib/orb → orb}/models/customers/cost_list_params.rbi +45 -22
- data/rbi/orb/models/customers/cost_list_response.rbi +254 -0
- data/rbi/{lib/orb → orb}/models/customers/credit_list_by_external_id_params.rbi +18 -15
- data/rbi/orb/models/customers/credit_list_by_external_id_response.rbi +110 -0
- data/rbi/{lib/orb → orb}/models/customers/credit_list_params.rbi +18 -15
- data/rbi/{lib/orb → orb}/models/customers/credit_list_response.rbi +44 -21
- data/rbi/{lib/orb/models/customers/credits/ledger_create_entry_params.rbi → orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi} +118 -60
- data/rbi/{lib/orb/models/customers/credits/ledger_create_entry_response.rbi → orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi} +685 -468
- data/rbi/{lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi → orb/models/customers/credits/ledger_create_entry_params.rbi} +107 -69
- data/rbi/{lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi → orb/models/customers/credits/ledger_create_entry_response.rbi} +643 -470
- data/rbi/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +224 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_list_by_external_id_response.rbi +658 -469
- data/rbi/orb/models/customers/credits/ledger_list_params.rbi +224 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/ledger_list_response.rbi +708 -459
- data/rbi/{lib/orb/models/customers/credits/top_up_create_params.rbi → orb/models/customers/credits/top_up_create_by_external_id_params.rbi} +87 -46
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_by_external_id_response.rbi +65 -48
- data/rbi/{lib/orb/models/customers/credits/top_up_create_by_external_id_params.rbi → orb/models/customers/credits/top_up_create_params.rbi} +73 -54
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_response.rbi +83 -43
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_delete_by_external_id_params.rbi +16 -6
- data/rbi/orb/models/customers/credits/top_up_delete_params.rbi +36 -0
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_by_external_id_params.rbi +9 -5
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_by_external_id_response.rbi +70 -49
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_params.rbi +9 -5
- data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_response.rbi +84 -43
- data/rbi/{lib/orb → orb}/models/dimensional_price_group.rbi +18 -15
- data/rbi/{lib/orb → orb}/models/dimensional_price_group_create_params.rbi +19 -16
- data/rbi/{lib/orb → orb}/models/dimensional_price_group_list_params.rbi +16 -6
- data/rbi/orb/models/dimensional_price_group_retrieve_params.rbi +24 -0
- data/rbi/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +26 -0
- data/rbi/orb/models/dimensional_price_groups.rbi +38 -0
- data/rbi/orb/models/discount.rbi +23 -0
- data/rbi/{lib/orb → orb}/models/evaluate_price_group.rbi +28 -12
- data/rbi/orb/models/event_deprecate_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/event_deprecate_response.rbi +8 -3
- data/rbi/{lib/orb → orb}/models/event_ingest_params.rbi +37 -31
- data/rbi/{lib/orb → orb}/models/event_ingest_response.rbi +63 -23
- data/rbi/{lib/orb → orb}/models/event_search_params.rbi +17 -14
- data/rbi/{lib/orb → orb}/models/event_search_response.rbi +33 -21
- data/rbi/{lib/orb → orb}/models/event_update_params.rbi +19 -16
- data/rbi/{lib/orb → orb}/models/event_update_response.rbi +8 -3
- data/rbi/orb/models/events/backfill_close_params.rbi +26 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_close_response.rbi +64 -29
- data/rbi/{lib/orb → orb}/models/events/backfill_create_params.rbi +21 -18
- data/rbi/{lib/orb → orb}/models/events/backfill_create_response.rbi +63 -29
- data/rbi/orb/models/events/backfill_fetch_params.rbi +26 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_fetch_response.rbi +64 -29
- data/rbi/{lib/orb → orb}/models/events/backfill_list_params.rbi +16 -6
- data/rbi/{lib/orb → orb}/models/events/backfill_list_response.rbi +62 -28
- data/rbi/orb/models/events/backfill_revert_params.rbi +26 -0
- data/rbi/{lib/orb → orb}/models/events/backfill_revert_response.rbi +63 -29
- data/rbi/{lib/orb → orb}/models/events/event_volumes.rbi +34 -12
- data/rbi/{lib/orb → orb}/models/events/volume_list_params.rbi +18 -15
- data/rbi/{lib/orb → orb}/models/invoice.rbi +1294 -831
- data/rbi/{lib/orb → orb}/models/invoice_create_params.rbi +97 -69
- data/rbi/orb/models/invoice_fetch_params.rbi +24 -0
- data/rbi/orb/models/invoice_fetch_upcoming_params.rbi +32 -0
- data/rbi/{lib/orb → orb}/models/invoice_fetch_upcoming_response.rbi +2003 -885
- data/rbi/{lib/orb → orb}/models/invoice_issue_params.rbi +16 -5
- data/rbi/orb/models/invoice_level_discount.rbi +22 -0
- data/rbi/{lib/orb → orb}/models/invoice_line_item_create_params.rbi +20 -17
- data/rbi/{lib/orb → orb}/models/invoice_line_item_create_response.rbi +594 -421
- data/rbi/{lib/orb → orb}/models/invoice_list_params.rbi +67 -47
- data/rbi/{lib/orb → orb}/models/invoice_mark_paid_params.rbi +17 -14
- data/rbi/orb/models/invoice_pay_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/invoice_update_params.rbi +15 -10
- data/rbi/orb/models/invoice_void_params.rbi +24 -0
- data/rbi/orb/models/item.rbi +143 -0
- data/rbi/{lib/orb → orb}/models/item_create_params.rbi +14 -5
- data/rbi/orb/models/item_fetch_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/item_list_params.rbi +16 -6
- data/rbi/orb/models/item_update_params.rbi +141 -0
- data/rbi/{lib/orb → orb}/models/metric_create_params.rbi +19 -16
- data/rbi/orb/models/metric_fetch_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/metric_list_params.rbi +20 -17
- data/rbi/{lib/orb → orb}/models/metric_update_params.rbi +15 -10
- data/rbi/orb/models/pagination_metadata.rbi +31 -0
- data/rbi/{lib/orb → orb}/models/percentage_discount.rbi +32 -19
- data/rbi/{lib/orb → orb}/models/plan.rbi +501 -370
- data/rbi/{lib/orb → orb}/models/plan_create_params.rbi +4243 -3094
- data/rbi/orb/models/plan_fetch_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/plan_list_params.rbi +34 -27
- data/rbi/{lib/orb → orb}/models/plan_update_params.rbi +16 -13
- data/rbi/orb/models/plans/external_plan_id_fetch_params.rbi +26 -0
- data/rbi/{lib/orb → orb}/models/plans/external_plan_id_update_params.rbi +16 -13
- data/rbi/orb/models/price.rbi +19414 -0
- data/rbi/{lib/orb → orb}/models/price_create_params.rbi +501 -245
- data/rbi/{lib/orb → orb}/models/price_evaluate_params.rbi +20 -17
- data/rbi/orb/models/price_evaluate_response.rbi +24 -0
- data/rbi/orb/models/price_fetch_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/price_list_params.rbi +16 -6
- data/rbi/{lib/orb → orb}/models/price_update_params.rbi +15 -10
- data/rbi/orb/models/prices/external_price_id_fetch_params.rbi +26 -0
- data/rbi/{lib/orb → orb}/models/prices/external_price_id_update_params.rbi +15 -10
- data/rbi/{lib/orb → orb}/models/subscription.rbi +586 -428
- data/rbi/{lib/orb → orb}/models/subscription_cancel_params.rbi +44 -22
- data/rbi/{lib/orb → orb}/models/subscription_cancel_response.rbi +724 -462
- data/rbi/{lib/orb → orb}/models/subscription_change_apply_params.rbi +16 -13
- data/rbi/{lib/orb → orb}/models/subscription_change_apply_response.rbi +808 -528
- data/rbi/orb/models/subscription_change_cancel_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/subscription_change_cancel_response.rbi +807 -538
- data/rbi/orb/models/subscription_change_retrieve_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/subscription_change_retrieve_response.rbi +806 -548
- data/rbi/{lib/orb/models/subscription_schedule_plan_change_params.rbi → orb/models/subscription_create_params.rbi} +8466 -7080
- data/rbi/{lib/orb → orb}/models/subscription_create_response.rbi +724 -462
- data/rbi/{lib/orb → orb}/models/subscription_fetch_costs_params.rbi +47 -22
- data/rbi/orb/models/subscription_fetch_costs_response.rbi +252 -0
- data/rbi/orb/models/subscription_fetch_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/subscription_fetch_schedule_params.rbi +20 -17
- data/rbi/{lib/orb → orb}/models/subscription_fetch_schedule_response.rbi +33 -19
- data/rbi/{lib/orb → orb}/models/subscription_fetch_usage_params.rbi +81 -34
- data/rbi/{lib/orb → orb}/models/subscription_list_params.rbi +39 -28
- data/rbi/{lib/orb → orb}/models/subscription_price_intervals_params.rbi +4973 -3944
- data/rbi/{lib/orb → orb}/models/subscription_price_intervals_response.rbi +744 -477
- data/rbi/{lib/orb/models/subscription_create_params.rbi → orb/models/subscription_schedule_plan_change_params.rbi} +8649 -7019
- data/rbi/{lib/orb → orb}/models/subscription_schedule_plan_change_response.rbi +742 -491
- data/rbi/{lib/orb → orb}/models/subscription_trigger_phase_params.rbi +16 -13
- data/rbi/{lib/orb → orb}/models/subscription_trigger_phase_response.rbi +736 -472
- data/rbi/orb/models/subscription_unschedule_cancellation_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_cancellation_response.rbi +743 -491
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +16 -5
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +717 -526
- data/rbi/orb/models/subscription_unschedule_pending_plan_changes_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/subscription_unschedule_pending_plan_changes_response.rbi +732 -521
- data/rbi/{lib/orb → orb}/models/subscription_update_fixed_fee_quantity_params.rbi +57 -26
- data/rbi/{lib/orb → orb}/models/subscription_update_fixed_fee_quantity_response.rbi +743 -491
- data/rbi/{lib/orb → orb}/models/subscription_update_params.rbi +19 -16
- data/rbi/orb/models/subscription_update_trial_params.rbi +104 -0
- data/rbi/{lib/orb → orb}/models/subscription_update_trial_response.rbi +736 -471
- data/rbi/orb/models/subscription_usage.rbi +446 -0
- data/rbi/orb/models/subscriptions.rbi +38 -0
- data/rbi/orb/models/top_level_ping_params.rbi +24 -0
- data/rbi/{lib/orb → orb}/models/top_level_ping_response.rbi +7 -3
- data/rbi/{lib/orb → orb}/models/trial_discount.rbi +29 -20
- data/rbi/{lib/orb → orb}/models/usage_discount.rbi +28 -19
- data/rbi/orb/models.rbi +231 -0
- data/rbi/{lib/orb → orb}/request_options.rbi +12 -4
- data/rbi/{lib/orb → orb}/resources/alerts.rbi +57 -42
- data/rbi/{lib/orb → orb}/resources/coupons/subscriptions.rbi +7 -5
- data/rbi/{lib/orb → orb}/resources/coupons.rbi +25 -22
- data/rbi/{lib/orb → orb}/resources/credit_notes.rbi +18 -15
- data/rbi/{lib/orb → orb}/resources/customers/balance_transactions.rbi +17 -9
- data/rbi/{lib/orb → orb}/resources/customers/costs.rbi +18 -11
- data/rbi/{lib/orb → orb}/resources/customers/credits/ledger.rbi +98 -74
- data/rbi/{lib/orb → orb}/resources/customers/credits/top_ups.rbi +53 -29
- data/rbi/{lib/orb → orb}/resources/customers/credits.rbi +16 -7
- data/rbi/{lib/orb → orb}/resources/customers.rbi +117 -82
- data/rbi/{lib/orb → orb}/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi +6 -5
- data/rbi/{lib/orb → orb}/resources/dimensional_price_groups.rbi +21 -14
- data/rbi/{lib/orb → orb}/resources/events/backfills.rbi +25 -20
- data/rbi/{lib/orb → orb}/resources/events/volume.rbi +7 -5
- data/rbi/{lib/orb → orb}/resources/events.rbi +22 -18
- data/rbi/{lib/orb → orb}/resources/invoice_line_items.rbi +7 -5
- data/rbi/{lib/orb → orb}/resources/invoices.rbi +55 -49
- data/rbi/{lib/orb → orb}/resources/items.rbi +31 -17
- data/rbi/{lib/orb → orb}/resources/metrics.rbi +21 -17
- data/rbi/{lib/orb → orb}/resources/plans/external_plan_id.rbi +11 -9
- data/rbi/{lib/orb → orb}/resources/plans.rbi +53 -49
- data/rbi/orb/resources/prices/external_price_id.rbi +108 -0
- data/rbi/{lib/orb → orb}/resources/prices.rbi +170 -157
- data/rbi/{lib/orb → orb}/resources/subscription_changes.rbi +15 -13
- data/rbi/{lib/orb → orb}/resources/subscriptions.rbi +188 -118
- data/rbi/{lib/orb → orb}/resources/top_level.rbi +7 -4
- data/sig/orb/internal/page.rbs +0 -2
- data/sig/orb/internal/type/request_parameters.rbs +3 -1
- data/sig/orb/internal/util.rbs +2 -0
- data/sig/orb/models/alert.rbs +19 -31
- data/sig/orb/models/alert_create_for_customer_params.rbs +3 -7
- data/sig/orb/models/alert_create_for_external_customer_params.rbs +3 -7
- data/sig/orb/models/alert_create_for_subscription_params.rbs +3 -7
- data/sig/orb/models/alert_disable_params.rbs +0 -2
- data/sig/orb/models/alert_enable_params.rbs +0 -2
- data/sig/orb/models/alert_list_params.rbs +0 -2
- data/sig/orb/models/alert_retrieve_params.rbs +0 -2
- data/sig/orb/models/alert_update_params.rbs +3 -7
- data/sig/orb/models/amount_discount.rbs +4 -6
- data/sig/orb/models/billable_metric.rbs +7 -9
- data/sig/orb/models/coupon.rbs +5 -8
- data/sig/orb/models/coupon_archive_params.rbs +0 -2
- data/sig/orb/models/coupon_create_params.rbs +7 -14
- data/sig/orb/models/coupon_fetch_params.rbs +0 -2
- data/sig/orb/models/coupon_list_params.rbs +0 -2
- data/sig/orb/models/coupons/subscription_list_params.rbs +0 -2
- data/sig/orb/models/credit_note.rbs +48 -66
- data/sig/orb/models/credit_note_create_params.rbs +3 -7
- data/sig/orb/models/credit_note_fetch_params.rbs +0 -2
- data/sig/orb/models/credit_note_list_params.rbs +0 -2
- data/sig/orb/models/customer.rbs +43 -63
- data/sig/orb/models/customer_create_params.rbs +36 -57
- data/sig/orb/models/customer_delete_params.rbs +0 -2
- data/sig/orb/models/customer_fetch_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customer_fetch_params.rbs +0 -2
- data/sig/orb/models/customer_list_params.rbs +0 -2
- data/sig/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbs +0 -2
- data/sig/orb/models/customer_sync_payment_methods_from_gateway_params.rbs +0 -2
- data/sig/orb/models/customer_update_by_external_id_params.rbs +36 -57
- data/sig/orb/models/customer_update_params.rbs +36 -57
- data/sig/orb/models/customers/balance_transaction_create_params.rbs +0 -2
- data/sig/orb/models/customers/balance_transaction_create_response.rbs +0 -6
- data/sig/orb/models/customers/balance_transaction_list_params.rbs +0 -2
- data/sig/orb/models/customers/balance_transaction_list_response.rbs +0 -6
- data/sig/orb/models/customers/cost_list_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/cost_list_by_external_id_response.rbs +0 -6
- data/sig/orb/models/customers/cost_list_params.rbs +0 -2
- data/sig/orb/models/customers/cost_list_response.rbs +0 -6
- data/sig/orb/models/customers/credit_list_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/credit_list_by_external_id_response.rbs +0 -2
- data/sig/orb/models/customers/credit_list_params.rbs +0 -2
- data/sig/orb/models/customers/credit_list_response.rbs +0 -2
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbs +3 -7
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +92 -134
- data/sig/orb/models/customers/credits/ledger_create_entry_params.rbs +3 -7
- data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +92 -134
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +92 -134
- data/sig/orb/models/customers/credits/ledger_list_params.rbs +0 -2
- data/sig/orb/models/customers/credits/ledger_list_response.rbs +92 -134
- data/sig/orb/models/customers/credits/top_up_create_by_external_id_params.rbs +3 -7
- data/sig/orb/models/customers/credits/top_up_create_by_external_id_response.rbs +0 -4
- data/sig/orb/models/customers/credits/top_up_create_params.rbs +3 -7
- data/sig/orb/models/customers/credits/top_up_create_response.rbs +0 -4
- data/sig/orb/models/customers/credits/top_up_delete_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/credits/top_up_delete_params.rbs +0 -2
- data/sig/orb/models/customers/credits/top_up_list_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/credits/top_up_list_by_external_id_response.rbs +0 -4
- data/sig/orb/models/customers/credits/top_up_list_params.rbs +0 -2
- data/sig/orb/models/customers/credits/top_up_list_response.rbs +0 -4
- data/sig/orb/models/dimensional_price_group.rbs +0 -2
- data/sig/orb/models/dimensional_price_group_create_params.rbs +0 -2
- data/sig/orb/models/dimensional_price_group_list_params.rbs +0 -2
- data/sig/orb/models/dimensional_price_group_retrieve_params.rbs +0 -2
- data/sig/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbs +0 -2
- data/sig/orb/models/dimensional_price_groups.rbs +6 -8
- data/sig/orb/models/discount.rbs +5 -5
- data/sig/orb/models/evaluate_price_group.rbs +4 -6
- data/sig/orb/models/event_deprecate_params.rbs +0 -2
- data/sig/orb/models/event_deprecate_response.rbs +0 -2
- data/sig/orb/models/event_ingest_params.rbs +3 -7
- data/sig/orb/models/event_ingest_response.rbs +0 -6
- data/sig/orb/models/event_search_params.rbs +0 -2
- data/sig/orb/models/event_search_response.rbs +0 -4
- data/sig/orb/models/event_update_params.rbs +0 -2
- data/sig/orb/models/event_update_response.rbs +0 -2
- data/sig/orb/models/events/backfill_close_params.rbs +0 -2
- data/sig/orb/models/events/backfill_close_response.rbs +0 -2
- data/sig/orb/models/events/backfill_create_params.rbs +0 -2
- data/sig/orb/models/events/backfill_create_response.rbs +0 -2
- data/sig/orb/models/events/backfill_fetch_params.rbs +0 -2
- data/sig/orb/models/events/backfill_fetch_response.rbs +0 -2
- data/sig/orb/models/events/backfill_list_params.rbs +0 -2
- data/sig/orb/models/events/backfill_list_response.rbs +0 -2
- data/sig/orb/models/events/backfill_revert_params.rbs +0 -2
- data/sig/orb/models/events/backfill_revert_response.rbs +0 -2
- data/sig/orb/models/events/event_volumes.rbs +3 -10
- data/sig/orb/models/events/volume_list_params.rbs +0 -2
- data/sig/orb/models/invoice.rbs +126 -188
- data/sig/orb/models/invoice_create_params.rbs +10 -16
- data/sig/orb/models/invoice_fetch_params.rbs +0 -2
- data/sig/orb/models/invoice_fetch_upcoming_params.rbs +0 -2
- data/sig/orb/models/invoice_fetch_upcoming_response.rbs +41 -103
- data/sig/orb/models/invoice_issue_params.rbs +0 -2
- data/sig/orb/models/invoice_level_discount.rbs +2 -4
- data/sig/orb/models/invoice_line_item_create_params.rbs +0 -2
- data/sig/orb/models/invoice_line_item_create_response.rbs +41 -75
- data/sig/orb/models/invoice_list_params.rbs +4 -6
- data/sig/orb/models/invoice_mark_paid_params.rbs +0 -2
- data/sig/orb/models/invoice_pay_params.rbs +0 -2
- data/sig/orb/models/invoice_update_params.rbs +0 -2
- data/sig/orb/models/invoice_void_params.rbs +0 -2
- data/sig/orb/models/item.rbs +7 -11
- data/sig/orb/models/item_create_params.rbs +0 -2
- data/sig/orb/models/item_fetch_params.rbs +0 -2
- data/sig/orb/models/item_list_params.rbs +0 -2
- data/sig/orb/models/item_update_params.rbs +7 -11
- data/sig/orb/models/metric_create_params.rbs +0 -2
- data/sig/orb/models/metric_fetch_params.rbs +0 -2
- data/sig/orb/models/metric_list_params.rbs +0 -2
- data/sig/orb/models/metric_update_params.rbs +0 -2
- data/sig/orb/models/pagination_metadata.rbs +0 -2
- data/sig/orb/models/percentage_discount.rbs +4 -6
- data/sig/orb/models/plan.rbs +55 -83
- data/sig/orb/models/plan_create_params.rbs +568 -746
- data/sig/orb/models/plan_fetch_params.rbs +0 -2
- data/sig/orb/models/plan_list_params.rbs +0 -2
- data/sig/orb/models/plan_update_params.rbs +0 -2
- data/sig/orb/models/plans/external_plan_id_fetch_params.rbs +0 -2
- data/sig/orb/models/plans/external_plan_id_update_params.rbs +0 -2
- data/sig/orb/models/price.rbs +1250 -1790
- data/sig/orb/models/price_create_params.rbs +59 -97
- data/sig/orb/models/price_evaluate_params.rbs +0 -2
- data/sig/orb/models/price_evaluate_response.rbs +3 -6
- data/sig/orb/models/price_fetch_params.rbs +0 -2
- data/sig/orb/models/price_list_params.rbs +0 -2
- data/sig/orb/models/price_update_params.rbs +0 -2
- data/sig/orb/models/prices/external_price_id_fetch_params.rbs +0 -2
- data/sig/orb/models/prices/external_price_id_update_params.rbs +0 -2
- data/sig/orb/models/subscription.rbs +72 -110
- data/sig/orb/models/subscription_cancel_params.rbs +0 -2
- data/sig/orb/models/subscription_cancel_response.rbs +44 -84
- data/sig/orb/models/subscription_change_apply_params.rbs +0 -2
- data/sig/orb/models/subscription_change_apply_response.rbs +44 -86
- data/sig/orb/models/subscription_change_cancel_params.rbs +0 -2
- data/sig/orb/models/subscription_change_cancel_response.rbs +44 -86
- data/sig/orb/models/subscription_change_retrieve_params.rbs +0 -2
- data/sig/orb/models/subscription_change_retrieve_response.rbs +44 -86
- data/sig/orb/models/subscription_create_params.rbs +1223 -1619
- data/sig/orb/models/subscription_create_response.rbs +44 -84
- data/sig/orb/models/subscription_fetch_costs_params.rbs +0 -2
- data/sig/orb/models/subscription_fetch_costs_response.rbs +0 -6
- data/sig/orb/models/subscription_fetch_params.rbs +0 -2
- data/sig/orb/models/subscription_fetch_schedule_params.rbs +0 -2
- data/sig/orb/models/subscription_fetch_schedule_response.rbs +0 -4
- data/sig/orb/models/subscription_fetch_usage_params.rbs +0 -2
- data/sig/orb/models/subscription_list_params.rbs +0 -2
- data/sig/orb/models/subscription_price_intervals_params.rbs +738 -970
- data/sig/orb/models/subscription_price_intervals_response.rbs +44 -84
- data/sig/orb/models/subscription_schedule_plan_change_params.rbs +1223 -1619
- data/sig/orb/models/subscription_schedule_plan_change_response.rbs +44 -84
- data/sig/orb/models/subscription_trigger_phase_params.rbs +0 -2
- data/sig/orb/models/subscription_trigger_phase_response.rbs +44 -84
- data/sig/orb/models/subscription_unschedule_cancellation_params.rbs +0 -2
- data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +44 -84
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbs +0 -2
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +44 -84
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_params.rbs +0 -2
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +44 -84
- data/sig/orb/models/subscription_update_fixed_fee_quantity_params.rbs +0 -2
- data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +44 -84
- data/sig/orb/models/subscription_update_params.rbs +0 -2
- data/sig/orb/models/subscription_update_trial_params.rbs +1 -3
- data/sig/orb/models/subscription_update_trial_response.rbs +44 -84
- data/sig/orb/models/subscription_usage.rbs +35 -53
- data/sig/orb/models/subscriptions.rbs +6 -8
- data/sig/orb/models/top_level_ping_params.rbs +0 -2
- data/sig/orb/models/top_level_ping_response.rbs +0 -2
- data/sig/orb/models/trial_discount.rbs +4 -6
- data/sig/orb/models/usage_discount.rbs +4 -6
- data/sig/orb/models.rbs +215 -0
- data/sig/orb/request_options.rbs +1 -1
- data/sig/orb/resources/alerts.rbs +12 -12
- data/sig/orb/resources/coupons/subscriptions.rbs +1 -1
- data/sig/orb/resources/coupons.rbs +4 -4
- data/sig/orb/resources/credit_notes.rbs +4 -4
- data/sig/orb/resources/customers/credits/ledger.rbs +2 -2
- data/sig/orb/resources/customers/credits/top_ups.rbs +2 -2
- data/sig/orb/resources/customers.rbs +24 -24
- data/sig/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbs +1 -1
- data/sig/orb/resources/dimensional_price_groups.rbs +3 -3
- data/sig/orb/resources/events/volume.rbs +1 -1
- data/sig/orb/resources/events.rbs +1 -1
- data/sig/orb/resources/invoices.rbs +10 -10
- data/sig/orb/resources/items.rbs +5 -5
- data/sig/orb/resources/metrics.rbs +4 -4
- data/sig/orb/resources/plans/external_plan_id.rbs +2 -2
- data/sig/orb/resources/plans.rbs +5 -5
- data/sig/orb/resources/prices.rbs +11 -11
- data/sig/orb/resources/subscriptions.rbs +21 -21
- metadata +226 -223
- data/rbi/lib/orb/internal/type/array_of.rbi +0 -90
- data/rbi/lib/orb/internal/type/request_parameters.rbi +0 -21
- data/rbi/lib/orb/internal/type/union.rbi +0 -75
- data/rbi/lib/orb/internal/type/unknown.rbi +0 -42
- data/rbi/lib/orb/internal/util.rbi +0 -299
- data/rbi/lib/orb/models/alert_retrieve_params.rbi +0 -18
- data/rbi/lib/orb/models/billing_cycle_relative_date.rbi +0 -18
- data/rbi/lib/orb/models/coupon_archive_params.rbi +0 -18
- data/rbi/lib/orb/models/coupon_fetch_params.rbi +0 -18
- data/rbi/lib/orb/models/credit_note_create_params.rbi +0 -88
- data/rbi/lib/orb/models/credit_note_fetch_params.rbi +0 -18
- data/rbi/lib/orb/models/customer_delete_params.rbi +0 -18
- data/rbi/lib/orb/models/customer_fetch_by_external_id_params.rbi +0 -18
- data/rbi/lib/orb/models/customer_fetch_params.rbi +0 -18
- data/rbi/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +0 -18
- data/rbi/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rbi +0 -18
- data/rbi/lib/orb/models/customers/balance_transaction_create_params.rbi +0 -65
- data/rbi/lib/orb/models/customers/balance_transaction_create_response.rbi +0 -208
- data/rbi/lib/orb/models/customers/balance_transaction_list_response.rbi +0 -196
- data/rbi/lib/orb/models/customers/cost_list_by_external_id_response.rbi +0 -225
- data/rbi/lib/orb/models/customers/cost_list_response.rbi +0 -223
- data/rbi/lib/orb/models/customers/credit_list_by_external_id_response.rbi +0 -84
- data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +0 -166
- data/rbi/lib/orb/models/customers/credits/ledger_list_params.rbi +0 -141
- data/rbi/lib/orb/models/customers/credits/top_up_delete_params.rbi +0 -26
- data/rbi/lib/orb/models/dimensional_price_group_retrieve_params.rbi +0 -18
- data/rbi/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +0 -25
- data/rbi/lib/orb/models/dimensional_price_groups.rbi +0 -33
- data/rbi/lib/orb/models/discount.rbi +0 -17
- data/rbi/lib/orb/models/event_deprecate_params.rbi +0 -18
- data/rbi/lib/orb/models/events/backfill_close_params.rbi +0 -25
- data/rbi/lib/orb/models/events/backfill_fetch_params.rbi +0 -25
- data/rbi/lib/orb/models/events/backfill_revert_params.rbi +0 -25
- data/rbi/lib/orb/models/invoice_fetch_params.rbi +0 -18
- data/rbi/lib/orb/models/invoice_fetch_upcoming_params.rbi +0 -22
- data/rbi/lib/orb/models/invoice_level_discount.rbi +0 -15
- data/rbi/lib/orb/models/invoice_pay_params.rbi +0 -18
- data/rbi/lib/orb/models/invoice_void_params.rbi +0 -18
- data/rbi/lib/orb/models/item.rbi +0 -95
- data/rbi/lib/orb/models/item_fetch_params.rbi +0 -18
- data/rbi/lib/orb/models/item_update_params.rbi +0 -101
- data/rbi/lib/orb/models/metric_fetch_params.rbi +0 -18
- data/rbi/lib/orb/models/pagination_metadata.rbi +0 -19
- data/rbi/lib/orb/models/plan_fetch_params.rbi +0 -18
- data/rbi/lib/orb/models/plans/external_plan_id_fetch_params.rbi +0 -25
- data/rbi/lib/orb/models/price.rbi +0 -14861
- data/rbi/lib/orb/models/price_evaluate_response.rbi +0 -19
- data/rbi/lib/orb/models/price_fetch_params.rbi +0 -18
- data/rbi/lib/orb/models/prices/external_price_id_fetch_params.rbi +0 -25
- data/rbi/lib/orb/models/subscription_change_cancel_params.rbi +0 -18
- data/rbi/lib/orb/models/subscription_change_retrieve_params.rbi +0 -18
- data/rbi/lib/orb/models/subscription_fetch_costs_response.rbi +0 -221
- data/rbi/lib/orb/models/subscription_fetch_params.rbi +0 -18
- data/rbi/lib/orb/models/subscription_unschedule_cancellation_params.rbi +0 -18
- data/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rbi +0 -18
- data/rbi/lib/orb/models/subscription_update_trial_params.rbi +0 -66
- data/rbi/lib/orb/models/subscription_usage.rbi +0 -296
- data/rbi/lib/orb/models/subscriptions.rbi +0 -31
- data/rbi/lib/orb/models/top_level_ping_params.rbi +0 -18
- data/rbi/lib/orb/resources/prices/external_price_id.rbi +0 -106
- /data/rbi/{lib/orb → orb}/internal.rbi +0 -0
- /data/rbi/{lib/orb → orb}/version.rbi +0 -0
data/rbi/orb/models.rbi
ADDED
@@ -0,0 +1,231 @@
|
|
1
|
+
# typed: strong
|
2
|
+
|
3
|
+
module Orb
|
4
|
+
Alert = Orb::Models::Alert
|
5
|
+
|
6
|
+
AlertCreateForCustomerParams = Orb::Models::AlertCreateForCustomerParams
|
7
|
+
|
8
|
+
AlertCreateForExternalCustomerParams =
|
9
|
+
Orb::Models::AlertCreateForExternalCustomerParams
|
10
|
+
|
11
|
+
AlertCreateForSubscriptionParams =
|
12
|
+
Orb::Models::AlertCreateForSubscriptionParams
|
13
|
+
|
14
|
+
AlertDisableParams = Orb::Models::AlertDisableParams
|
15
|
+
|
16
|
+
AlertEnableParams = Orb::Models::AlertEnableParams
|
17
|
+
|
18
|
+
AlertListParams = Orb::Models::AlertListParams
|
19
|
+
|
20
|
+
AlertRetrieveParams = Orb::Models::AlertRetrieveParams
|
21
|
+
|
22
|
+
AlertUpdateParams = Orb::Models::AlertUpdateParams
|
23
|
+
|
24
|
+
AmountDiscount = Orb::Models::AmountDiscount
|
25
|
+
|
26
|
+
BillableMetric = Orb::Models::BillableMetric
|
27
|
+
|
28
|
+
BillingCycleRelativeDate = Orb::Models::BillingCycleRelativeDate
|
29
|
+
|
30
|
+
Coupon = Orb::Models::Coupon
|
31
|
+
|
32
|
+
CouponArchiveParams = Orb::Models::CouponArchiveParams
|
33
|
+
|
34
|
+
CouponCreateParams = Orb::Models::CouponCreateParams
|
35
|
+
|
36
|
+
CouponFetchParams = Orb::Models::CouponFetchParams
|
37
|
+
|
38
|
+
CouponListParams = Orb::Models::CouponListParams
|
39
|
+
|
40
|
+
Coupons = Orb::Models::Coupons
|
41
|
+
|
42
|
+
CreditNote = Orb::Models::CreditNote
|
43
|
+
|
44
|
+
CreditNoteCreateParams = Orb::Models::CreditNoteCreateParams
|
45
|
+
|
46
|
+
CreditNoteFetchParams = Orb::Models::CreditNoteFetchParams
|
47
|
+
|
48
|
+
CreditNoteListParams = Orb::Models::CreditNoteListParams
|
49
|
+
|
50
|
+
Customer = Orb::Models::Customer
|
51
|
+
|
52
|
+
CustomerCreateParams = Orb::Models::CustomerCreateParams
|
53
|
+
|
54
|
+
CustomerDeleteParams = Orb::Models::CustomerDeleteParams
|
55
|
+
|
56
|
+
CustomerFetchByExternalIDParams = Orb::Models::CustomerFetchByExternalIDParams
|
57
|
+
|
58
|
+
CustomerFetchParams = Orb::Models::CustomerFetchParams
|
59
|
+
|
60
|
+
CustomerListParams = Orb::Models::CustomerListParams
|
61
|
+
|
62
|
+
Customers = Orb::Models::Customers
|
63
|
+
|
64
|
+
CustomerSyncPaymentMethodsFromGatewayByExternalCustomerIDParams =
|
65
|
+
Orb::Models::CustomerSyncPaymentMethodsFromGatewayByExternalCustomerIDParams
|
66
|
+
|
67
|
+
CustomerSyncPaymentMethodsFromGatewayParams =
|
68
|
+
Orb::Models::CustomerSyncPaymentMethodsFromGatewayParams
|
69
|
+
|
70
|
+
CustomerUpdateByExternalIDParams =
|
71
|
+
Orb::Models::CustomerUpdateByExternalIDParams
|
72
|
+
|
73
|
+
CustomerUpdateParams = Orb::Models::CustomerUpdateParams
|
74
|
+
|
75
|
+
DimensionalPriceGroup = Orb::Models::DimensionalPriceGroup
|
76
|
+
|
77
|
+
DimensionalPriceGroupCreateParams =
|
78
|
+
Orb::Models::DimensionalPriceGroupCreateParams
|
79
|
+
|
80
|
+
DimensionalPriceGroupListParams = Orb::Models::DimensionalPriceGroupListParams
|
81
|
+
|
82
|
+
DimensionalPriceGroupRetrieveParams =
|
83
|
+
Orb::Models::DimensionalPriceGroupRetrieveParams
|
84
|
+
|
85
|
+
DimensionalPriceGroups = Orb::Models::DimensionalPriceGroups
|
86
|
+
|
87
|
+
DimensionalPriceGroupsAPI = Orb::Models::DimensionalPriceGroupsAPI
|
88
|
+
|
89
|
+
Discount = Orb::Models::Discount
|
90
|
+
|
91
|
+
EvaluatePriceGroup = Orb::Models::EvaluatePriceGroup
|
92
|
+
|
93
|
+
EventDeprecateParams = Orb::Models::EventDeprecateParams
|
94
|
+
|
95
|
+
EventIngestParams = Orb::Models::EventIngestParams
|
96
|
+
|
97
|
+
Events = Orb::Models::Events
|
98
|
+
|
99
|
+
EventSearchParams = Orb::Models::EventSearchParams
|
100
|
+
|
101
|
+
EventUpdateParams = Orb::Models::EventUpdateParams
|
102
|
+
|
103
|
+
Invoice = Orb::Models::Invoice
|
104
|
+
|
105
|
+
InvoiceCreateParams = Orb::Models::InvoiceCreateParams
|
106
|
+
|
107
|
+
InvoiceFetchParams = Orb::Models::InvoiceFetchParams
|
108
|
+
|
109
|
+
InvoiceFetchUpcomingParams = Orb::Models::InvoiceFetchUpcomingParams
|
110
|
+
|
111
|
+
InvoiceIssueParams = Orb::Models::InvoiceIssueParams
|
112
|
+
|
113
|
+
InvoiceLevelDiscount = Orb::Models::InvoiceLevelDiscount
|
114
|
+
|
115
|
+
InvoiceLineItemCreateParams = Orb::Models::InvoiceLineItemCreateParams
|
116
|
+
|
117
|
+
InvoiceListParams = Orb::Models::InvoiceListParams
|
118
|
+
|
119
|
+
InvoiceMarkPaidParams = Orb::Models::InvoiceMarkPaidParams
|
120
|
+
|
121
|
+
InvoicePayParams = Orb::Models::InvoicePayParams
|
122
|
+
|
123
|
+
InvoiceUpdateParams = Orb::Models::InvoiceUpdateParams
|
124
|
+
|
125
|
+
InvoiceVoidParams = Orb::Models::InvoiceVoidParams
|
126
|
+
|
127
|
+
Item = Orb::Models::Item
|
128
|
+
|
129
|
+
ItemCreateParams = Orb::Models::ItemCreateParams
|
130
|
+
|
131
|
+
ItemFetchParams = Orb::Models::ItemFetchParams
|
132
|
+
|
133
|
+
ItemListParams = Orb::Models::ItemListParams
|
134
|
+
|
135
|
+
ItemUpdateParams = Orb::Models::ItemUpdateParams
|
136
|
+
|
137
|
+
MetricCreateParams = Orb::Models::MetricCreateParams
|
138
|
+
|
139
|
+
MetricFetchParams = Orb::Models::MetricFetchParams
|
140
|
+
|
141
|
+
MetricListParams = Orb::Models::MetricListParams
|
142
|
+
|
143
|
+
MetricUpdateParams = Orb::Models::MetricUpdateParams
|
144
|
+
|
145
|
+
PaginationMetadata = Orb::Models::PaginationMetadata
|
146
|
+
|
147
|
+
PercentageDiscount = Orb::Models::PercentageDiscount
|
148
|
+
|
149
|
+
Plan = Orb::Models::Plan
|
150
|
+
|
151
|
+
PlanCreateParams = Orb::Models::PlanCreateParams
|
152
|
+
|
153
|
+
PlanFetchParams = Orb::Models::PlanFetchParams
|
154
|
+
|
155
|
+
PlanListParams = Orb::Models::PlanListParams
|
156
|
+
|
157
|
+
Plans = Orb::Models::Plans
|
158
|
+
|
159
|
+
PlanUpdateParams = Orb::Models::PlanUpdateParams
|
160
|
+
|
161
|
+
Price = Orb::Models::Price
|
162
|
+
|
163
|
+
PriceCreateParams = Orb::Models::PriceCreateParams
|
164
|
+
|
165
|
+
PriceEvaluateParams = Orb::Models::PriceEvaluateParams
|
166
|
+
|
167
|
+
PriceFetchParams = Orb::Models::PriceFetchParams
|
168
|
+
|
169
|
+
PriceListParams = Orb::Models::PriceListParams
|
170
|
+
|
171
|
+
Prices = Orb::Models::Prices
|
172
|
+
|
173
|
+
PriceUpdateParams = Orb::Models::PriceUpdateParams
|
174
|
+
|
175
|
+
Subscription = Orb::Models::Subscription
|
176
|
+
|
177
|
+
SubscriptionCancelParams = Orb::Models::SubscriptionCancelParams
|
178
|
+
|
179
|
+
SubscriptionChangeApplyParams = Orb::Models::SubscriptionChangeApplyParams
|
180
|
+
|
181
|
+
SubscriptionChangeCancelParams = Orb::Models::SubscriptionChangeCancelParams
|
182
|
+
|
183
|
+
SubscriptionChangeRetrieveParams =
|
184
|
+
Orb::Models::SubscriptionChangeRetrieveParams
|
185
|
+
|
186
|
+
SubscriptionCreateParams = Orb::Models::SubscriptionCreateParams
|
187
|
+
|
188
|
+
SubscriptionFetchCostsParams = Orb::Models::SubscriptionFetchCostsParams
|
189
|
+
|
190
|
+
SubscriptionFetchParams = Orb::Models::SubscriptionFetchParams
|
191
|
+
|
192
|
+
SubscriptionFetchScheduleParams = Orb::Models::SubscriptionFetchScheduleParams
|
193
|
+
|
194
|
+
SubscriptionFetchUsageParams = Orb::Models::SubscriptionFetchUsageParams
|
195
|
+
|
196
|
+
SubscriptionListParams = Orb::Models::SubscriptionListParams
|
197
|
+
|
198
|
+
SubscriptionPriceIntervalsParams =
|
199
|
+
Orb::Models::SubscriptionPriceIntervalsParams
|
200
|
+
|
201
|
+
SubscriptionsAPI = Orb::Models::SubscriptionsAPI
|
202
|
+
|
203
|
+
SubscriptionSchedulePlanChangeParams =
|
204
|
+
Orb::Models::SubscriptionSchedulePlanChangeParams
|
205
|
+
|
206
|
+
SubscriptionTriggerPhaseParams = Orb::Models::SubscriptionTriggerPhaseParams
|
207
|
+
|
208
|
+
SubscriptionUnscheduleCancellationParams =
|
209
|
+
Orb::Models::SubscriptionUnscheduleCancellationParams
|
210
|
+
|
211
|
+
SubscriptionUnscheduleFixedFeeQuantityUpdatesParams =
|
212
|
+
Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesParams
|
213
|
+
|
214
|
+
SubscriptionUnschedulePendingPlanChangesParams =
|
215
|
+
Orb::Models::SubscriptionUnschedulePendingPlanChangesParams
|
216
|
+
|
217
|
+
SubscriptionUpdateFixedFeeQuantityParams =
|
218
|
+
Orb::Models::SubscriptionUpdateFixedFeeQuantityParams
|
219
|
+
|
220
|
+
SubscriptionUpdateParams = Orb::Models::SubscriptionUpdateParams
|
221
|
+
|
222
|
+
SubscriptionUpdateTrialParams = Orb::Models::SubscriptionUpdateTrialParams
|
223
|
+
|
224
|
+
SubscriptionUsage = Orb::Models::SubscriptionUsage
|
225
|
+
|
226
|
+
TopLevelPingParams = Orb::Models::TopLevelPingParams
|
227
|
+
|
228
|
+
TrialDiscount = Orb::Models::TrialDiscount
|
229
|
+
|
230
|
+
UsageDiscount = Orb::Models::UsageDiscount
|
231
|
+
end
|
@@ -7,9 +7,12 @@ module Orb
|
|
7
7
|
# When making a request, you can pass an actual {RequestOptions} instance, or
|
8
8
|
# simply pass a Hash with symbol keys matching the attributes on this class.
|
9
9
|
class RequestOptions < Orb::Internal::Type::BaseModel
|
10
|
+
OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
|
11
|
+
|
10
12
|
# @api private
|
11
|
-
sig { params(opts:
|
12
|
-
def self.validate!(opts)
|
13
|
+
sig { params(opts: Orb::RequestOptions::OrHash).void }
|
14
|
+
def self.validate!(opts)
|
15
|
+
end
|
13
16
|
|
14
17
|
# Idempotency key to send with request and all associated retries. Will only be
|
15
18
|
# sent for write requests.
|
@@ -18,7 +21,11 @@ module Orb
|
|
18
21
|
|
19
22
|
# Extra query params to send with the request. These are `.merge`’d into any
|
20
23
|
# `query` given at the client level.
|
21
|
-
sig
|
24
|
+
sig do
|
25
|
+
returns(
|
26
|
+
T.nilable(T::Hash[String, T.nilable(T.any(T::Array[String], String))])
|
27
|
+
)
|
28
|
+
end
|
22
29
|
attr_accessor :extra_query
|
23
30
|
|
24
31
|
# Extra headers to send with the request. These are `.merged`’d into any
|
@@ -41,6 +48,7 @@ module Orb
|
|
41
48
|
|
42
49
|
# Returns a new instance of RequestOptions.
|
43
50
|
sig { params(values: Orb::Internal::AnyHash).returns(T.attached_class) }
|
44
|
-
def self.new(values = {})
|
51
|
+
def self.new(values = {})
|
52
|
+
end
|
45
53
|
end
|
46
54
|
end
|
@@ -7,27 +7,28 @@ module Orb
|
|
7
7
|
sig do
|
8
8
|
params(
|
9
9
|
alert_id: String,
|
10
|
-
request_options:
|
11
|
-
)
|
12
|
-
|
10
|
+
request_options: Orb::RequestOptions::OrHash
|
11
|
+
).returns(Orb::Alert)
|
12
|
+
end
|
13
|
+
def retrieve(alert_id, request_options: {})
|
13
14
|
end
|
14
|
-
def retrieve(alert_id, request_options: {}); end
|
15
15
|
|
16
16
|
# This endpoint updates the thresholds of an alert.
|
17
17
|
sig do
|
18
18
|
params(
|
19
19
|
alert_configuration_id: String,
|
20
|
-
thresholds: T::Array[
|
21
|
-
request_options:
|
22
|
-
)
|
23
|
-
.returns(Orb::Models::Alert)
|
20
|
+
thresholds: T::Array[Orb::AlertUpdateParams::Threshold::OrHash],
|
21
|
+
request_options: Orb::RequestOptions::OrHash
|
22
|
+
).returns(Orb::Alert)
|
24
23
|
end
|
25
24
|
def update(
|
26
25
|
alert_configuration_id,
|
27
26
|
# The thresholds that define the values at which the alert will be triggered.
|
28
27
|
thresholds:,
|
29
28
|
request_options: {}
|
30
|
-
)
|
29
|
+
)
|
30
|
+
end
|
31
|
+
|
31
32
|
# This endpoint returns a list of alerts within Orb.
|
32
33
|
#
|
33
34
|
# The request must specify one of `customer_id`, `external_customer_id`, or
|
@@ -50,9 +51,8 @@ module Orb
|
|
50
51
|
external_customer_id: T.nilable(String),
|
51
52
|
limit: Integer,
|
52
53
|
subscription_id: T.nilable(String),
|
53
|
-
request_options:
|
54
|
-
)
|
55
|
-
.returns(Orb::Internal::Page[Orb::Models::Alert])
|
54
|
+
request_options: Orb::RequestOptions::OrHash
|
55
|
+
).returns(Orb::Internal::Page[Orb::Alert])
|
56
56
|
end
|
57
57
|
def list(
|
58
58
|
created_at_gt: nil,
|
@@ -71,7 +71,9 @@ module Orb
|
|
71
71
|
# Fetch alerts scoped to this subscription_id
|
72
72
|
subscription_id: nil,
|
73
73
|
request_options: {}
|
74
|
-
)
|
74
|
+
)
|
75
|
+
end
|
76
|
+
|
75
77
|
# This endpoint creates a new alert to monitor a customer's credit balance. There
|
76
78
|
# are three types of alerts that can be scoped to customers:
|
77
79
|
# `credit_balance_depleted`, `credit_balance_dropped`, and
|
@@ -84,11 +86,13 @@ module Orb
|
|
84
86
|
params(
|
85
87
|
customer_id: String,
|
86
88
|
currency: String,
|
87
|
-
type: Orb::
|
88
|
-
thresholds:
|
89
|
-
|
90
|
-
|
91
|
-
|
89
|
+
type: Orb::AlertCreateForCustomerParams::Type::OrSymbol,
|
90
|
+
thresholds:
|
91
|
+
T.nilable(
|
92
|
+
T::Array[Orb::AlertCreateForCustomerParams::Threshold::OrHash]
|
93
|
+
),
|
94
|
+
request_options: Orb::RequestOptions::OrHash
|
95
|
+
).returns(Orb::Alert)
|
92
96
|
end
|
93
97
|
def create_for_customer(
|
94
98
|
customer_id,
|
@@ -99,7 +103,9 @@ module Orb
|
|
99
103
|
# The thresholds that define the values at which the alert will be triggered.
|
100
104
|
thresholds: nil,
|
101
105
|
request_options: {}
|
102
|
-
)
|
106
|
+
)
|
107
|
+
end
|
108
|
+
|
103
109
|
# This endpoint creates a new alert to monitor a customer's credit balance. There
|
104
110
|
# are three types of alerts that can be scoped to customers:
|
105
111
|
# `credit_balance_depleted`, `credit_balance_dropped`, and
|
@@ -112,13 +118,15 @@ module Orb
|
|
112
118
|
params(
|
113
119
|
external_customer_id: String,
|
114
120
|
currency: String,
|
115
|
-
type: Orb::
|
116
|
-
thresholds:
|
117
|
-
T
|
118
|
-
|
119
|
-
|
120
|
-
|
121
|
-
|
121
|
+
type: Orb::AlertCreateForExternalCustomerParams::Type::OrSymbol,
|
122
|
+
thresholds:
|
123
|
+
T.nilable(
|
124
|
+
T::Array[
|
125
|
+
Orb::AlertCreateForExternalCustomerParams::Threshold::OrHash
|
126
|
+
]
|
127
|
+
),
|
128
|
+
request_options: Orb::RequestOptions::OrHash
|
129
|
+
).returns(Orb::Alert)
|
122
130
|
end
|
123
131
|
def create_for_external_customer(
|
124
132
|
external_customer_id,
|
@@ -129,7 +137,9 @@ module Orb
|
|
129
137
|
# The thresholds that define the values at which the alert will be triggered.
|
130
138
|
thresholds: nil,
|
131
139
|
request_options: {}
|
132
|
-
)
|
140
|
+
)
|
141
|
+
end
|
142
|
+
|
133
143
|
# This endpoint is used to create alerts at the subscription level.
|
134
144
|
#
|
135
145
|
# Subscription level alerts can be one of two types: `usage_exceeded` or
|
@@ -144,12 +154,12 @@ module Orb
|
|
144
154
|
sig do
|
145
155
|
params(
|
146
156
|
subscription_id: String,
|
147
|
-
thresholds:
|
148
|
-
|
157
|
+
thresholds:
|
158
|
+
T::Array[Orb::AlertCreateForSubscriptionParams::Threshold::OrHash],
|
159
|
+
type: Orb::AlertCreateForSubscriptionParams::Type::OrSymbol,
|
149
160
|
metric_id: T.nilable(String),
|
150
|
-
request_options:
|
151
|
-
)
|
152
|
-
.returns(Orb::Models::Alert)
|
161
|
+
request_options: Orb::RequestOptions::OrHash
|
162
|
+
).returns(Orb::Alert)
|
153
163
|
end
|
154
164
|
def create_for_subscription(
|
155
165
|
subscription_id,
|
@@ -160,7 +170,9 @@ module Orb
|
|
160
170
|
# The metric to track usage for.
|
161
171
|
metric_id: nil,
|
162
172
|
request_options: {}
|
163
|
-
)
|
173
|
+
)
|
174
|
+
end
|
175
|
+
|
164
176
|
# This endpoint allows you to disable an alert. To disable a plan-level alert for
|
165
177
|
# a specific subscription, you must include the `subscription_id`. The
|
166
178
|
# `subscription_id` is not required for customer or subscription level alerts.
|
@@ -168,16 +180,17 @@ module Orb
|
|
168
180
|
params(
|
169
181
|
alert_configuration_id: String,
|
170
182
|
subscription_id: T.nilable(String),
|
171
|
-
request_options:
|
172
|
-
)
|
173
|
-
.returns(Orb::Models::Alert)
|
183
|
+
request_options: Orb::RequestOptions::OrHash
|
184
|
+
).returns(Orb::Alert)
|
174
185
|
end
|
175
186
|
def disable(
|
176
187
|
alert_configuration_id,
|
177
188
|
# Used to update the status of a plan alert scoped to this subscription_id
|
178
189
|
subscription_id: nil,
|
179
190
|
request_options: {}
|
180
|
-
)
|
191
|
+
)
|
192
|
+
end
|
193
|
+
|
181
194
|
# This endpoint allows you to enable an alert. To enable a plan-level alert for a
|
182
195
|
# specific subscription, you must include the `subscription_id`. The
|
183
196
|
# `subscription_id` is not required for customer or subscription level alerts.
|
@@ -185,19 +198,21 @@ module Orb
|
|
185
198
|
params(
|
186
199
|
alert_configuration_id: String,
|
187
200
|
subscription_id: T.nilable(String),
|
188
|
-
request_options:
|
189
|
-
)
|
190
|
-
.returns(Orb::Models::Alert)
|
201
|
+
request_options: Orb::RequestOptions::OrHash
|
202
|
+
).returns(Orb::Alert)
|
191
203
|
end
|
192
204
|
def enable(
|
193
205
|
alert_configuration_id,
|
194
206
|
# Used to update the status of a plan alert scoped to this subscription_id
|
195
207
|
subscription_id: nil,
|
196
208
|
request_options: {}
|
197
|
-
)
|
209
|
+
)
|
210
|
+
end
|
211
|
+
|
198
212
|
# @api private
|
199
213
|
sig { params(client: Orb::Client).returns(T.attached_class) }
|
200
|
-
def self.new(client:)
|
214
|
+
def self.new(client:)
|
215
|
+
end
|
201
216
|
end
|
202
217
|
end
|
203
218
|
end
|
@@ -13,9 +13,8 @@ module Orb
|
|
13
13
|
coupon_id: String,
|
14
14
|
cursor: T.nilable(String),
|
15
15
|
limit: Integer,
|
16
|
-
request_options:
|
17
|
-
)
|
18
|
-
.returns(Orb::Internal::Page[Orb::Models::Subscription])
|
16
|
+
request_options: Orb::RequestOptions::OrHash
|
17
|
+
).returns(Orb::Internal::Page[Orb::Subscription])
|
19
18
|
end
|
20
19
|
def list(
|
21
20
|
coupon_id,
|
@@ -25,10 +24,13 @@ module Orb
|
|
25
24
|
# The number of items to fetch. Defaults to 20.
|
26
25
|
limit: nil,
|
27
26
|
request_options: {}
|
28
|
-
)
|
27
|
+
)
|
28
|
+
end
|
29
|
+
|
29
30
|
# @api private
|
30
31
|
sig { params(client: Orb::Client).returns(T.attached_class) }
|
31
|
-
def self.new(client:)
|
32
|
+
def self.new(client:)
|
33
|
+
end
|
32
34
|
end
|
33
35
|
end
|
34
36
|
end
|
@@ -10,17 +10,16 @@ module Orb
|
|
10
10
|
# subscription creation or plan change.
|
11
11
|
sig do
|
12
12
|
params(
|
13
|
-
discount:
|
14
|
-
|
15
|
-
|
16
|
-
|
17
|
-
|
13
|
+
discount:
|
14
|
+
T.any(
|
15
|
+
Orb::CouponCreateParams::Discount::Percentage::OrHash,
|
16
|
+
Orb::CouponCreateParams::Discount::Amount::OrHash
|
17
|
+
),
|
18
18
|
redemption_code: String,
|
19
19
|
duration_in_months: T.nilable(Integer),
|
20
20
|
max_redemptions: T.nilable(Integer),
|
21
|
-
request_options:
|
22
|
-
)
|
23
|
-
.returns(Orb::Models::Coupon)
|
21
|
+
request_options: Orb::RequestOptions::OrHash
|
22
|
+
).returns(Orb::Coupon)
|
24
23
|
end
|
25
24
|
def create(
|
26
25
|
discount:,
|
@@ -33,7 +32,9 @@ module Orb
|
|
33
32
|
# exhausted;`null` here means "unlimited".
|
34
33
|
max_redemptions: nil,
|
35
34
|
request_options: {}
|
36
|
-
)
|
35
|
+
)
|
36
|
+
end
|
37
|
+
|
37
38
|
# This endpoint returns a list of all coupons for an account in a list format.
|
38
39
|
#
|
39
40
|
# The list of coupons is ordered starting from the most recently created coupon.
|
@@ -46,9 +47,8 @@ module Orb
|
|
46
47
|
limit: Integer,
|
47
48
|
redemption_code: T.nilable(String),
|
48
49
|
show_archived: T.nilable(T::Boolean),
|
49
|
-
request_options:
|
50
|
-
)
|
51
|
-
.returns(Orb::Internal::Page[Orb::Models::Coupon])
|
50
|
+
request_options: Orb::RequestOptions::OrHash
|
51
|
+
).returns(Orb::Internal::Page[Orb::Coupon])
|
52
52
|
end
|
53
53
|
def list(
|
54
54
|
# Cursor for pagination. This can be populated by the `next_cursor` value returned
|
@@ -62,18 +62,20 @@ module Orb
|
|
62
62
|
# coupons).
|
63
63
|
show_archived: nil,
|
64
64
|
request_options: {}
|
65
|
-
)
|
65
|
+
)
|
66
|
+
end
|
67
|
+
|
66
68
|
# This endpoint allows a coupon to be archived. Archived coupons can no longer be
|
67
69
|
# redeemed, and will be hidden from lists of active coupons. Additionally, once a
|
68
70
|
# coupon is archived, its redemption code can be reused for a different coupon.
|
69
71
|
sig do
|
70
72
|
params(
|
71
73
|
coupon_id: String,
|
72
|
-
request_options:
|
73
|
-
)
|
74
|
-
|
74
|
+
request_options: Orb::RequestOptions::OrHash
|
75
|
+
).returns(Orb::Coupon)
|
76
|
+
end
|
77
|
+
def archive(coupon_id, request_options: {})
|
75
78
|
end
|
76
|
-
def archive(coupon_id, request_options: {}); end
|
77
79
|
|
78
80
|
# This endpoint retrieves a coupon by its ID. To fetch coupons by their redemption
|
79
81
|
# code, use the [List coupons](list-coupons) endpoint with the redemption_code
|
@@ -81,15 +83,16 @@ module Orb
|
|
81
83
|
sig do
|
82
84
|
params(
|
83
85
|
coupon_id: String,
|
84
|
-
request_options:
|
85
|
-
)
|
86
|
-
|
86
|
+
request_options: Orb::RequestOptions::OrHash
|
87
|
+
).returns(Orb::Coupon)
|
88
|
+
end
|
89
|
+
def fetch(coupon_id, request_options: {})
|
87
90
|
end
|
88
|
-
def fetch(coupon_id, request_options: {}); end
|
89
91
|
|
90
92
|
# @api private
|
91
93
|
sig { params(client: Orb::Client).returns(T.attached_class) }
|
92
|
-
def self.new(client:)
|
94
|
+
def self.new(client:)
|
95
|
+
end
|
93
96
|
end
|
94
97
|
end
|
95
98
|
end
|
@@ -7,12 +7,11 @@ module Orb
|
|
7
7
|
# [`Credit Note`](/invoicing/credit-notes).
|
8
8
|
sig do
|
9
9
|
params(
|
10
|
-
line_items: T::Array[
|
10
|
+
line_items: T::Array[Orb::CreditNoteCreateParams::LineItem::OrHash],
|
11
11
|
memo: T.nilable(String),
|
12
|
-
reason: T.nilable(Orb::
|
13
|
-
request_options:
|
14
|
-
)
|
15
|
-
.returns(Orb::Models::CreditNote)
|
12
|
+
reason: T.nilable(Orb::CreditNoteCreateParams::Reason::OrSymbol),
|
13
|
+
request_options: Orb::RequestOptions::OrHash
|
14
|
+
).returns(Orb::CreditNote)
|
16
15
|
end
|
17
16
|
def create(
|
18
17
|
line_items:,
|
@@ -21,7 +20,9 @@ module Orb
|
|
21
20
|
# An optional reason for the credit note.
|
22
21
|
reason: nil,
|
23
22
|
request_options: {}
|
24
|
-
)
|
23
|
+
)
|
24
|
+
end
|
25
|
+
|
25
26
|
# Get a paginated list of CreditNotes. Users can also filter by customer_id,
|
26
27
|
# subscription_id, or external_customer_id. The credit notes will be returned in
|
27
28
|
# reverse chronological order by `creation_time`.
|
@@ -33,9 +34,8 @@ module Orb
|
|
33
34
|
created_at_lte: T.nilable(Time),
|
34
35
|
cursor: T.nilable(String),
|
35
36
|
limit: Integer,
|
36
|
-
request_options:
|
37
|
-
)
|
38
|
-
.returns(Orb::Internal::Page[Orb::Models::CreditNote])
|
37
|
+
request_options: Orb::RequestOptions::OrHash
|
38
|
+
).returns(Orb::Internal::Page[Orb::CreditNote])
|
39
39
|
end
|
40
40
|
def list(
|
41
41
|
created_at_gt: nil,
|
@@ -48,21 +48,24 @@ module Orb
|
|
48
48
|
# The number of items to fetch. Defaults to 20.
|
49
49
|
limit: nil,
|
50
50
|
request_options: {}
|
51
|
-
)
|
51
|
+
)
|
52
|
+
end
|
53
|
+
|
52
54
|
# This endpoint is used to fetch a single [`Credit Note`](/invoicing/credit-notes)
|
53
55
|
# given an identifier.
|
54
56
|
sig do
|
55
57
|
params(
|
56
58
|
credit_note_id: String,
|
57
|
-
request_options:
|
58
|
-
)
|
59
|
-
|
59
|
+
request_options: Orb::RequestOptions::OrHash
|
60
|
+
).returns(Orb::CreditNote)
|
61
|
+
end
|
62
|
+
def fetch(credit_note_id, request_options: {})
|
60
63
|
end
|
61
|
-
def fetch(credit_note_id, request_options: {}); end
|
62
64
|
|
63
65
|
# @api private
|
64
66
|
sig { params(client: Orb::Client).returns(T.attached_class) }
|
65
|
-
def self.new(client:)
|
67
|
+
def self.new(client:)
|
68
|
+
end
|
66
69
|
end
|
67
70
|
end
|
68
71
|
end
|