orb-billing 0.1.0.pre.alpha.38 → 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 +1 -1
- data/lib/orb/client.rb +4 -0
- data/lib/orb/internal/transport/base_client.rb +1 -1
- data/lib/orb/internal/transport/pooled_net_requester.rb +1 -1
- data/lib/orb/internal/type/base_model.rb +14 -17
- data/lib/orb/internal/type/converter.rb +20 -22
- data/lib/orb/internal/type/enum.rb +8 -8
- data/lib/orb/internal/util.rb +1 -5
- data/lib/orb/models/alert.rb +9 -9
- 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 +2 -2
- 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 +232 -232
- data/lib/orb/models/customer_create_params.rb +223 -223
- data/lib/orb/models/customer_list_params.rb +5 -5
- data/lib/orb/models/customer_update_by_external_id_params.rb +224 -224
- data/lib/orb/models/customer_update_params.rb +224 -224
- 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 +2 -2
- data/lib/orb/models/customers/credit_list_params.rb +2 -2
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +20 -20
- 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 +20 -20
- 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 +8 -8
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +7 -7
- data/lib/orb/models/customers/credits/top_up_create_params.rb +8 -8
- data/lib/orb/models/customers/credits/top_up_create_response.rb +7 -7
- 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 +7 -7
- data/lib/orb/models/customers/credits/top_up_list_params.rb +1 -1
- data/lib/orb/models/customers/credits/top_up_list_response.rb +7 -7
- 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/event_ingest_params.rb +7 -7
- 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 +8 -8
- data/lib/orb/models/event_update_params.rb +4 -4
- data/lib/orb/models/events/backfill_close_response.rb +7 -7
- data/lib/orb/models/events/backfill_create_params.rb +11 -11
- data/lib/orb/models/events/backfill_create_response.rb +7 -7
- data/lib/orb/models/events/backfill_fetch_response.rb +7 -7
- data/lib/orb/models/events/backfill_list_params.rb +1 -1
- data/lib/orb/models/events/backfill_list_response.rb +7 -7
- data/lib/orb/models/events/backfill_revert_response.rb +7 -7
- 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 +270 -270
- data/lib/orb/models/invoice_create_params.rb +12 -11
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +266 -266
- data/lib/orb/models/invoice_issue_params.rb +4 -4
- data/lib/orb/models/invoice_line_item_create_params.rb +1 -1
- data/lib/orb/models/invoice_line_item_create_response.rb +27 -27
- data/lib/orb/models/invoice_list_params.rb +12 -12
- 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/percentage_discount.rb +2 -2
- data/lib/orb/models/plan.rb +35 -35
- data/lib/orb/models/plan_create_params.rb +267 -267
- 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 +158 -158
- data/lib/orb/models/price_create_params.rb +20 -20
- 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 +114 -87
- data/lib/orb/models/subscription_cancel_params.rb +3 -3
- data/lib/orb/models/subscription_cancel_response.rb +150 -72
- 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 +641 -641
- data/lib/orb/models/subscription_create_response.rb +150 -72
- 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 +323 -323
- data/lib/orb/models/subscription_price_intervals_response.rb +152 -72
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +651 -651
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +152 -72
- data/lib/orb/models/subscription_trigger_phase_params.rb +3 -3
- data/lib/orb/models/subscription_trigger_phase_response.rb +152 -72
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +152 -72
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +153 -73
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +152 -72
- data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +8 -8
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +152 -72
- data/lib/orb/models/subscription_update_params.rb +10 -10
- data/lib/orb/models/subscription_update_trial_params.rb +3 -3
- data/lib/orb/models/subscription_update_trial_response.rb +152 -72
- 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 +38 -38
- data/lib/orb/resources/coupons/subscriptions.rb +3 -3
- data/lib/orb/resources/coupons.rb +9 -9
- data/lib/orb/resources/credit_notes.rb +8 -8
- data/lib/orb/resources/customers/balance_transactions.rb +26 -26
- data/lib/orb/resources/customers/costs.rb +232 -232
- data/lib/orb/resources/customers/credits/ledger.rb +344 -344
- 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 +59 -59
- 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 +38 -38
- data/lib/orb/resources/items.rb +1 -1
- data/lib/orb/resources/metrics.rb +11 -11
- data/lib/orb/resources/plans/external_plan_id.rb +14 -14
- data/lib/orb/resources/plans.rb +22 -22
- 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 +813 -813
- data/lib/orb/resources/top_level.rb +4 -4
- data/lib/orb/version.rb +1 -1
- data/lib/orb.rb +7 -0
- 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 +8 -16
- 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.rbi +4 -8
- 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 +34 -68
- 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/sig/orb/client.rbs +2 -0
- 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
- metadata +23 -2
@@ -26,8 +26,7 @@ module Orb
|
|
26
26
|
)
|
27
27
|
.returns(T.attached_class)
|
28
28
|
end
|
29
|
-
def self.new(amount:, type:, description: nil, request_options: {})
|
30
|
-
end
|
29
|
+
def self.new(amount:, type:, description: nil, request_options: {}); end
|
31
30
|
|
32
31
|
sig do
|
33
32
|
override
|
@@ -40,8 +39,7 @@ module Orb
|
|
40
39
|
}
|
41
40
|
)
|
42
41
|
end
|
43
|
-
def to_hash
|
44
|
-
end
|
42
|
+
def to_hash; end
|
45
43
|
|
46
44
|
module Type
|
47
45
|
extend Orb::Internal::Type::Enum
|
@@ -55,8 +53,7 @@ module Orb
|
|
55
53
|
DECREMENT = T.let(:decrement, Orb::Models::Customers::BalanceTransactionCreateParams::Type::TaggedSymbol)
|
56
54
|
|
57
55
|
sig { override.returns(T::Array[Orb::Models::Customers::BalanceTransactionCreateParams::Type::TaggedSymbol]) }
|
58
|
-
def self.values
|
59
|
-
end
|
56
|
+
def self.values; end
|
60
57
|
end
|
61
58
|
end
|
62
59
|
end
|
@@ -37,7 +37,7 @@ module Orb
|
|
37
37
|
attr_accessor :description
|
38
38
|
|
39
39
|
# The new value of the customer's balance prior to the transaction, in the
|
40
|
-
#
|
40
|
+
# customer's currency.
|
41
41
|
sig { returns(String) }
|
42
42
|
attr_accessor :ending_balance
|
43
43
|
|
@@ -55,7 +55,7 @@ module Orb
|
|
55
55
|
attr_writer :invoice
|
56
56
|
|
57
57
|
# The original value of the customer's balance prior to the transaction, in the
|
58
|
-
#
|
58
|
+
# customer's currency.
|
59
59
|
sig { returns(String) }
|
60
60
|
attr_accessor :starting_balance
|
61
61
|
|
@@ -92,9 +92,7 @@ module Orb
|
|
92
92
|
invoice:,
|
93
93
|
starting_balance:,
|
94
94
|
type:
|
95
|
-
)
|
96
|
-
end
|
97
|
-
|
95
|
+
); end
|
98
96
|
sig do
|
99
97
|
override
|
100
98
|
.returns(
|
@@ -112,8 +110,7 @@ module Orb
|
|
112
110
|
}
|
113
111
|
)
|
114
112
|
end
|
115
|
-
def to_hash
|
116
|
-
end
|
113
|
+
def to_hash; end
|
117
114
|
|
118
115
|
module Action
|
119
116
|
extend Orb::Internal::Type::Enum
|
@@ -152,8 +149,7 @@ module Orb
|
|
152
149
|
T.let(:external_payment, Orb::Models::Customers::BalanceTransactionCreateResponse::Action::TaggedSymbol)
|
153
150
|
|
154
151
|
sig { override.returns(T::Array[Orb::Models::Customers::BalanceTransactionCreateResponse::Action::TaggedSymbol]) }
|
155
|
-
def self.values
|
156
|
-
end
|
152
|
+
def self.values; end
|
157
153
|
end
|
158
154
|
|
159
155
|
class CreditNote < Orb::Internal::Type::BaseModel
|
@@ -162,12 +158,10 @@ module Orb
|
|
162
158
|
attr_accessor :id
|
163
159
|
|
164
160
|
sig { params(id: String).returns(T.attached_class) }
|
165
|
-
def self.new(id:)
|
166
|
-
end
|
161
|
+
def self.new(id:); end
|
167
162
|
|
168
163
|
sig { override.returns({id: String}) }
|
169
|
-
def to_hash
|
170
|
-
end
|
164
|
+
def to_hash; end
|
171
165
|
end
|
172
166
|
|
173
167
|
class Invoice < Orb::Internal::Type::BaseModel
|
@@ -176,12 +170,10 @@ module Orb
|
|
176
170
|
attr_accessor :id
|
177
171
|
|
178
172
|
sig { params(id: String).returns(T.attached_class) }
|
179
|
-
def self.new(id:)
|
180
|
-
end
|
173
|
+
def self.new(id:); end
|
181
174
|
|
182
175
|
sig { override.returns({id: String}) }
|
183
|
-
def to_hash
|
184
|
-
end
|
176
|
+
def to_hash; end
|
185
177
|
end
|
186
178
|
|
187
179
|
module Type
|
@@ -198,8 +190,7 @@ module Orb
|
|
198
190
|
T.let(:decrement, Orb::Models::Customers::BalanceTransactionCreateResponse::Type::TaggedSymbol)
|
199
191
|
|
200
192
|
sig { override.returns(T::Array[Orb::Models::Customers::BalanceTransactionCreateResponse::Type::TaggedSymbol]) }
|
201
|
-
def self.values
|
202
|
-
end
|
193
|
+
def self.values; end
|
203
194
|
end
|
204
195
|
end
|
205
196
|
end
|
@@ -8,7 +8,7 @@ module Orb
|
|
8
8
|
include Orb::Internal::Type::RequestParameters
|
9
9
|
|
10
10
|
# Cursor for pagination. This can be populated by the `next_cursor` value returned
|
11
|
-
#
|
11
|
+
# from the initial request.
|
12
12
|
sig { returns(T.nilable(String)) }
|
13
13
|
attr_accessor :cursor
|
14
14
|
|
@@ -51,9 +51,7 @@ module Orb
|
|
51
51
|
operation_time_lt: nil,
|
52
52
|
operation_time_lte: nil,
|
53
53
|
request_options: {}
|
54
|
-
)
|
55
|
-
end
|
56
|
-
|
54
|
+
); end
|
57
55
|
sig do
|
58
56
|
override
|
59
57
|
.returns(
|
@@ -68,8 +66,7 @@ module Orb
|
|
68
66
|
}
|
69
67
|
)
|
70
68
|
end
|
71
|
-
def to_hash
|
72
|
-
end
|
69
|
+
def to_hash; end
|
73
70
|
end
|
74
71
|
end
|
75
72
|
end
|
@@ -37,7 +37,7 @@ module Orb
|
|
37
37
|
attr_accessor :description
|
38
38
|
|
39
39
|
# The new value of the customer's balance prior to the transaction, in the
|
40
|
-
#
|
40
|
+
# customer's currency.
|
41
41
|
sig { returns(String) }
|
42
42
|
attr_accessor :ending_balance
|
43
43
|
|
@@ -53,7 +53,7 @@ module Orb
|
|
53
53
|
attr_writer :invoice
|
54
54
|
|
55
55
|
# The original value of the customer's balance prior to the transaction, in the
|
56
|
-
#
|
56
|
+
# customer's currency.
|
57
57
|
sig { returns(String) }
|
58
58
|
attr_accessor :starting_balance
|
59
59
|
|
@@ -88,9 +88,7 @@ module Orb
|
|
88
88
|
invoice:,
|
89
89
|
starting_balance:,
|
90
90
|
type:
|
91
|
-
)
|
92
|
-
end
|
93
|
-
|
91
|
+
); end
|
94
92
|
sig do
|
95
93
|
override
|
96
94
|
.returns(
|
@@ -108,8 +106,7 @@ module Orb
|
|
108
106
|
}
|
109
107
|
)
|
110
108
|
end
|
111
|
-
def to_hash
|
112
|
-
end
|
109
|
+
def to_hash; end
|
113
110
|
|
114
111
|
module Action
|
115
112
|
extend Orb::Internal::Type::Enum
|
@@ -142,8 +139,7 @@ module Orb
|
|
142
139
|
T.let(:external_payment, Orb::Models::Customers::BalanceTransactionListResponse::Action::TaggedSymbol)
|
143
140
|
|
144
141
|
sig { override.returns(T::Array[Orb::Models::Customers::BalanceTransactionListResponse::Action::TaggedSymbol]) }
|
145
|
-
def self.values
|
146
|
-
end
|
142
|
+
def self.values; end
|
147
143
|
end
|
148
144
|
|
149
145
|
class CreditNote < Orb::Internal::Type::BaseModel
|
@@ -152,12 +148,10 @@ module Orb
|
|
152
148
|
attr_accessor :id
|
153
149
|
|
154
150
|
sig { params(id: String).returns(T.attached_class) }
|
155
|
-
def self.new(id:)
|
156
|
-
end
|
151
|
+
def self.new(id:); end
|
157
152
|
|
158
153
|
sig { override.returns({id: String}) }
|
159
|
-
def to_hash
|
160
|
-
end
|
154
|
+
def to_hash; end
|
161
155
|
end
|
162
156
|
|
163
157
|
class Invoice < Orb::Internal::Type::BaseModel
|
@@ -166,12 +160,10 @@ module Orb
|
|
166
160
|
attr_accessor :id
|
167
161
|
|
168
162
|
sig { params(id: String).returns(T.attached_class) }
|
169
|
-
def self.new(id:)
|
170
|
-
end
|
163
|
+
def self.new(id:); end
|
171
164
|
|
172
165
|
sig { override.returns({id: String}) }
|
173
|
-
def to_hash
|
174
|
-
end
|
166
|
+
def to_hash; end
|
175
167
|
end
|
176
168
|
|
177
169
|
module Type
|
@@ -186,8 +178,7 @@ module Orb
|
|
186
178
|
DECREMENT = T.let(:decrement, Orb::Models::Customers::BalanceTransactionListResponse::Type::TaggedSymbol)
|
187
179
|
|
188
180
|
sig { override.returns(T::Array[Orb::Models::Customers::BalanceTransactionListResponse::Type::TaggedSymbol]) }
|
189
|
-
def self.values
|
190
|
-
end
|
181
|
+
def self.values; end
|
191
182
|
end
|
192
183
|
end
|
193
184
|
end
|
@@ -20,9 +20,9 @@ module Orb
|
|
20
20
|
attr_accessor :timeframe_start
|
21
21
|
|
22
22
|
# Controls whether Orb returns cumulative costs since the start of the billing
|
23
|
-
#
|
24
|
-
#
|
25
|
-
#
|
23
|
+
# period, or incremental day-by-day costs. If your customer has minimums or
|
24
|
+
# discounts, it's strongly recommended that you use the default cumulative
|
25
|
+
# behavior.
|
26
26
|
sig { returns(T.nilable(Orb::Models::Customers::CostListByExternalIDParams::ViewMode::OrSymbol)) }
|
27
27
|
attr_accessor :view_mode
|
28
28
|
|
@@ -57,13 +57,12 @@ module Orb
|
|
57
57
|
}
|
58
58
|
)
|
59
59
|
end
|
60
|
-
def to_hash
|
61
|
-
end
|
60
|
+
def to_hash; end
|
62
61
|
|
63
62
|
# Controls whether Orb returns cumulative costs since the start of the billing
|
64
|
-
#
|
65
|
-
#
|
66
|
-
#
|
63
|
+
# period, or incremental day-by-day costs. If your customer has minimums or
|
64
|
+
# discounts, it's strongly recommended that you use the default cumulative
|
65
|
+
# behavior.
|
67
66
|
module ViewMode
|
68
67
|
extend Orb::Internal::Type::Enum
|
69
68
|
|
@@ -77,8 +76,7 @@ module Orb
|
|
77
76
|
T.let(:cumulative, Orb::Models::Customers::CostListByExternalIDParams::ViewMode::TaggedSymbol)
|
78
77
|
|
79
78
|
sig { override.returns(T::Array[Orb::Models::Customers::CostListByExternalIDParams::ViewMode::TaggedSymbol]) }
|
80
|
-
def self.values
|
81
|
-
end
|
79
|
+
def self.values; end
|
82
80
|
end
|
83
81
|
end
|
84
82
|
end
|
@@ -13,12 +13,10 @@ module Orb
|
|
13
13
|
)
|
14
14
|
.returns(T.attached_class)
|
15
15
|
end
|
16
|
-
def self.new(data:)
|
17
|
-
end
|
16
|
+
def self.new(data:); end
|
18
17
|
|
19
18
|
sig { override.returns({data: T::Array[Orb::Models::Customers::CostListByExternalIDResponse::Data]}) }
|
20
|
-
def to_hash
|
21
|
-
end
|
19
|
+
def to_hash; end
|
22
20
|
|
23
21
|
class Data < Orb::Internal::Type::BaseModel
|
24
22
|
sig { returns(T::Array[Orb::Models::Customers::CostListByExternalIDResponse::Data::PerPriceCost]) }
|
@@ -48,8 +46,7 @@ module Orb
|
|
48
46
|
)
|
49
47
|
.returns(T.attached_class)
|
50
48
|
end
|
51
|
-
def self.new(per_price_costs:, subtotal:, timeframe_end:, timeframe_start:, total:)
|
52
|
-
end
|
49
|
+
def self.new(per_price_costs:, subtotal:, timeframe_end:, timeframe_start:, total:); end
|
53
50
|
|
54
51
|
sig do
|
55
52
|
override
|
@@ -63,8 +60,7 @@ module Orb
|
|
63
60
|
}
|
64
61
|
)
|
65
62
|
end
|
66
|
-
def to_hash
|
67
|
-
end
|
63
|
+
def to_hash; end
|
68
64
|
|
69
65
|
class PerPriceCost < Orb::Internal::Type::BaseModel
|
70
66
|
# The price object
|
@@ -160,8 +156,7 @@ module Orb
|
|
160
156
|
)
|
161
157
|
.returns(T.attached_class)
|
162
158
|
end
|
163
|
-
def self.new(price:, price_id:, subtotal:, total:, quantity: nil)
|
164
|
-
end
|
159
|
+
def self.new(price:, price_id:, subtotal:, total:, quantity: nil); end
|
165
160
|
|
166
161
|
sig do
|
167
162
|
override
|
@@ -204,8 +199,7 @@ module Orb
|
|
204
199
|
}
|
205
200
|
)
|
206
201
|
end
|
207
|
-
def to_hash
|
208
|
-
end
|
202
|
+
def to_hash; end
|
209
203
|
end
|
210
204
|
end
|
211
205
|
end
|
@@ -20,9 +20,9 @@ module Orb
|
|
20
20
|
attr_accessor :timeframe_start
|
21
21
|
|
22
22
|
# Controls whether Orb returns cumulative costs since the start of the billing
|
23
|
-
#
|
24
|
-
#
|
25
|
-
#
|
23
|
+
# period, or incremental day-by-day costs. If your customer has minimums or
|
24
|
+
# discounts, it's strongly recommended that you use the default cumulative
|
25
|
+
# behavior.
|
26
26
|
sig { returns(T.nilable(Orb::Models::Customers::CostListParams::ViewMode::OrSymbol)) }
|
27
27
|
attr_accessor :view_mode
|
28
28
|
|
@@ -57,13 +57,12 @@ module Orb
|
|
57
57
|
}
|
58
58
|
)
|
59
59
|
end
|
60
|
-
def to_hash
|
61
|
-
end
|
60
|
+
def to_hash; end
|
62
61
|
|
63
62
|
# Controls whether Orb returns cumulative costs since the start of the billing
|
64
|
-
#
|
65
|
-
#
|
66
|
-
#
|
63
|
+
# period, or incremental day-by-day costs. If your customer has minimums or
|
64
|
+
# discounts, it's strongly recommended that you use the default cumulative
|
65
|
+
# behavior.
|
67
66
|
module ViewMode
|
68
67
|
extend Orb::Internal::Type::Enum
|
69
68
|
|
@@ -75,8 +74,7 @@ module Orb
|
|
75
74
|
CUMULATIVE = T.let(:cumulative, Orb::Models::Customers::CostListParams::ViewMode::TaggedSymbol)
|
76
75
|
|
77
76
|
sig { override.returns(T::Array[Orb::Models::Customers::CostListParams::ViewMode::TaggedSymbol]) }
|
78
|
-
def self.values
|
79
|
-
end
|
77
|
+
def self.values; end
|
80
78
|
end
|
81
79
|
end
|
82
80
|
end
|
@@ -11,12 +11,10 @@ module Orb
|
|
11
11
|
params(data: T::Array[T.any(Orb::Models::Customers::CostListResponse::Data, Orb::Internal::AnyHash)])
|
12
12
|
.returns(T.attached_class)
|
13
13
|
end
|
14
|
-
def self.new(data:)
|
15
|
-
end
|
14
|
+
def self.new(data:); end
|
16
15
|
|
17
16
|
sig { override.returns({data: T::Array[Orb::Models::Customers::CostListResponse::Data]}) }
|
18
|
-
def to_hash
|
19
|
-
end
|
17
|
+
def to_hash; end
|
20
18
|
|
21
19
|
class Data < Orb::Internal::Type::BaseModel
|
22
20
|
sig { returns(T::Array[Orb::Models::Customers::CostListResponse::Data::PerPriceCost]) }
|
@@ -46,8 +44,7 @@ module Orb
|
|
46
44
|
)
|
47
45
|
.returns(T.attached_class)
|
48
46
|
end
|
49
|
-
def self.new(per_price_costs:, subtotal:, timeframe_end:, timeframe_start:, total:)
|
50
|
-
end
|
47
|
+
def self.new(per_price_costs:, subtotal:, timeframe_end:, timeframe_start:, total:); end
|
51
48
|
|
52
49
|
sig do
|
53
50
|
override
|
@@ -61,8 +58,7 @@ module Orb
|
|
61
58
|
}
|
62
59
|
)
|
63
60
|
end
|
64
|
-
def to_hash
|
65
|
-
end
|
61
|
+
def to_hash; end
|
66
62
|
|
67
63
|
class PerPriceCost < Orb::Internal::Type::BaseModel
|
68
64
|
# The price object
|
@@ -158,8 +154,7 @@ module Orb
|
|
158
154
|
)
|
159
155
|
.returns(T.attached_class)
|
160
156
|
end
|
161
|
-
def self.new(price:, price_id:, subtotal:, total:, quantity: nil)
|
162
|
-
end
|
157
|
+
def self.new(price:, price_id:, subtotal:, total:, quantity: nil); end
|
163
158
|
|
164
159
|
sig do
|
165
160
|
override
|
@@ -202,8 +197,7 @@ module Orb
|
|
202
197
|
}
|
203
198
|
)
|
204
199
|
end
|
205
|
-
def to_hash
|
206
|
-
end
|
200
|
+
def to_hash; end
|
207
201
|
end
|
208
202
|
end
|
209
203
|
end
|
@@ -12,12 +12,12 @@ module Orb
|
|
12
12
|
attr_accessor :currency
|
13
13
|
|
14
14
|
# Cursor for pagination. This can be populated by the `next_cursor` value returned
|
15
|
-
#
|
15
|
+
# from the initial request.
|
16
16
|
sig { returns(T.nilable(String)) }
|
17
17
|
attr_accessor :cursor
|
18
18
|
|
19
19
|
# If set to True, all expired and depleted blocks, as well as active block will be
|
20
|
-
#
|
20
|
+
# returned.
|
21
21
|
sig { returns(T.nilable(T::Boolean)) }
|
22
22
|
attr_reader :include_all_blocks
|
23
23
|
|
@@ -56,8 +56,7 @@ module Orb
|
|
56
56
|
}
|
57
57
|
)
|
58
58
|
end
|
59
|
-
def to_hash
|
60
|
-
end
|
59
|
+
def to_hash; end
|
61
60
|
end
|
62
61
|
end
|
63
62
|
end
|
@@ -62,8 +62,7 @@ module Orb
|
|
62
62
|
}
|
63
63
|
)
|
64
64
|
end
|
65
|
-
def to_hash
|
66
|
-
end
|
65
|
+
def to_hash; end
|
67
66
|
|
68
67
|
module Status
|
69
68
|
extend Orb::Internal::Type::Enum
|
@@ -78,8 +77,7 @@ module Orb
|
|
78
77
|
T.let(:pending_payment, Orb::Models::Customers::CreditListByExternalIDResponse::Status::TaggedSymbol)
|
79
78
|
|
80
79
|
sig { override.returns(T::Array[Orb::Models::Customers::CreditListByExternalIDResponse::Status::TaggedSymbol]) }
|
81
|
-
def self.values
|
82
|
-
end
|
80
|
+
def self.values; end
|
83
81
|
end
|
84
82
|
end
|
85
83
|
end
|
@@ -12,12 +12,12 @@ module Orb
|
|
12
12
|
attr_accessor :currency
|
13
13
|
|
14
14
|
# Cursor for pagination. This can be populated by the `next_cursor` value returned
|
15
|
-
#
|
15
|
+
# from the initial request.
|
16
16
|
sig { returns(T.nilable(String)) }
|
17
17
|
attr_accessor :cursor
|
18
18
|
|
19
19
|
# If set to True, all expired and depleted blocks, as well as active block will be
|
20
|
-
#
|
20
|
+
# returned.
|
21
21
|
sig { returns(T.nilable(T::Boolean)) }
|
22
22
|
attr_reader :include_all_blocks
|
23
23
|
|
@@ -56,8 +56,7 @@ module Orb
|
|
56
56
|
}
|
57
57
|
)
|
58
58
|
end
|
59
|
-
def to_hash
|
60
|
-
end
|
59
|
+
def to_hash; end
|
61
60
|
end
|
62
61
|
end
|
63
62
|
end
|
@@ -62,8 +62,7 @@ module Orb
|
|
62
62
|
}
|
63
63
|
)
|
64
64
|
end
|
65
|
-
def to_hash
|
66
|
-
end
|
65
|
+
def to_hash; end
|
67
66
|
|
68
67
|
module Status
|
69
68
|
extend Orb::Internal::Type::Enum
|
@@ -77,8 +76,7 @@ module Orb
|
|
77
76
|
T.let(:pending_payment, Orb::Models::Customers::CreditListResponse::Status::TaggedSymbol)
|
78
77
|
|
79
78
|
sig { override.returns(T::Array[Orb::Models::Customers::CreditListResponse::Status::TaggedSymbol]) }
|
80
|
-
def self.values
|
81
|
-
end
|
79
|
+
def self.values; end
|
82
80
|
end
|
83
81
|
end
|
84
82
|
end
|
@@ -9,7 +9,7 @@ module Orb
|
|
9
9
|
include Orb::Internal::Type::RequestParameters
|
10
10
|
|
11
11
|
# The number of credits to effect. Note that this is required for increment,
|
12
|
-
#
|
12
|
+
# decrement or void operations.
|
13
13
|
sig { returns(Float) }
|
14
14
|
attr_accessor :amount
|
15
15
|
|
@@ -17,18 +17,18 @@ module Orb
|
|
17
17
|
attr_accessor :entry_type
|
18
18
|
|
19
19
|
# The currency or custom pricing unit to use for this ledger entry. If this is a
|
20
|
-
#
|
20
|
+
# real-world currency, it must match the customer's invoicing currency.
|
21
21
|
sig { returns(T.nilable(String)) }
|
22
22
|
attr_accessor :currency
|
23
23
|
|
24
24
|
# Optional metadata that can be specified when adding ledger results via the API.
|
25
|
-
#
|
26
|
-
#
|
25
|
+
# For example, this can be used to note an increment refers to trial credits, or
|
26
|
+
# for noting corrections as a result of an incident, etc.
|
27
27
|
sig { returns(T.nilable(String)) }
|
28
28
|
attr_accessor :description
|
29
29
|
|
30
30
|
# An ISO 8601 format date that denotes when this credit balance should become
|
31
|
-
#
|
31
|
+
# available for use.
|
32
32
|
sig { returns(T.nilable(Time)) }
|
33
33
|
attr_accessor :effective_date
|
34
34
|
|
@@ -37,9 +37,9 @@ module Orb
|
|
37
37
|
attr_accessor :expiry_date
|
38
38
|
|
39
39
|
# Passing `invoice_settings` automatically generates an invoice for the newly
|
40
|
-
#
|
41
|
-
#
|
42
|
-
#
|
40
|
+
# added credits. If `invoice_settings` is passed, you must specify
|
41
|
+
# per_unit_cost_basis, as the calculation of the invoice total is done on that
|
42
|
+
# basis.
|
43
43
|
sig { returns(T.nilable(Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::InvoiceSettings)) }
|
44
44
|
attr_reader :invoice_settings
|
45
45
|
|
@@ -57,19 +57,19 @@ module Orb
|
|
57
57
|
attr_writer :invoice_settings
|
58
58
|
|
59
59
|
# User-specified key/value pairs for the resource. Individual keys can be removed
|
60
|
-
#
|
61
|
-
#
|
60
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
61
|
+
# by setting `metadata` to `null`.
|
62
62
|
sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) }
|
63
63
|
attr_accessor :metadata
|
64
64
|
|
65
65
|
# Can only be specified when entry_type=increment. How much, in the customer's
|
66
|
-
#
|
66
|
+
# currency, a customer paid for a single credit in this block
|
67
67
|
sig { returns(T.nilable(String)) }
|
68
68
|
attr_accessor :per_unit_cost_basis
|
69
69
|
|
70
70
|
# A future date (specified in YYYY-MM-DD format) used for expiration change,
|
71
|
-
#
|
72
|
-
#
|
71
|
+
# denoting when credits transferred (as part of a partial block expiration) should
|
72
|
+
# expire.
|
73
73
|
sig { returns(Date) }
|
74
74
|
attr_accessor :target_expiry_date
|
75
75
|
|
@@ -122,9 +122,7 @@ module Orb
|
|
122
122
|
per_unit_cost_basis: nil,
|
123
123
|
void_reason: nil,
|
124
124
|
request_options: {}
|
125
|
-
)
|
126
|
-
end
|
127
|
-
|
125
|
+
); end
|
128
126
|
sig do
|
129
127
|
override
|
130
128
|
.returns(
|
@@ -145,8 +143,7 @@ module Orb
|
|
145
143
|
}
|
146
144
|
)
|
147
145
|
end
|
148
|
-
def to_hash
|
149
|
-
end
|
146
|
+
def to_hash; end
|
150
147
|
|
151
148
|
module EntryType
|
152
149
|
extend Orb::Internal::Type::Enum
|
@@ -174,19 +171,18 @@ module Orb
|
|
174
171
|
T::Array[Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::EntryType::TaggedSymbol]
|
175
172
|
)
|
176
173
|
end
|
177
|
-
def self.values
|
178
|
-
end
|
174
|
+
def self.values; end
|
179
175
|
end
|
180
176
|
|
181
177
|
class InvoiceSettings < Orb::Internal::Type::BaseModel
|
182
178
|
# Whether the credits purchase invoice should auto collect with the customer's
|
183
|
-
#
|
179
|
+
# saved payment method.
|
184
180
|
sig { returns(T::Boolean) }
|
185
181
|
attr_accessor :auto_collection
|
186
182
|
|
187
183
|
# The net terms determines the difference between the invoice date and the issue
|
188
|
-
#
|
189
|
-
#
|
184
|
+
# date for the invoice. If you intend the invoice to be due on issue, set this
|
185
|
+
# to 0.
|
190
186
|
sig { returns(Integer) }
|
191
187
|
attr_accessor :net_terms
|
192
188
|
|
@@ -195,7 +191,7 @@ module Orb
|
|
195
191
|
attr_accessor :memo
|
196
192
|
|
197
193
|
# If true, the new credit block will require that the corresponding invoice is
|
198
|
-
#
|
194
|
+
# paid before it can be drawn down from.
|
199
195
|
sig { returns(T.nilable(T::Boolean)) }
|
200
196
|
attr_reader :require_successful_payment
|
201
197
|
|
@@ -203,9 +199,9 @@ module Orb
|
|
203
199
|
attr_writer :require_successful_payment
|
204
200
|
|
205
201
|
# Passing `invoice_settings` automatically generates an invoice for the newly
|
206
|
-
#
|
207
|
-
#
|
208
|
-
#
|
202
|
+
# added credits. If `invoice_settings` is passed, you must specify
|
203
|
+
# per_unit_cost_basis, as the calculation of the invoice total is done on that
|
204
|
+
# basis.
|
209
205
|
sig do
|
210
206
|
params(
|
211
207
|
auto_collection: T::Boolean,
|
@@ -215,8 +211,7 @@ module Orb
|
|
215
211
|
)
|
216
212
|
.returns(T.attached_class)
|
217
213
|
end
|
218
|
-
def self.new(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil)
|
219
|
-
end
|
214
|
+
def self.new(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil); end
|
220
215
|
|
221
216
|
sig do
|
222
217
|
override
|
@@ -229,8 +224,7 @@ module Orb
|
|
229
224
|
}
|
230
225
|
)
|
231
226
|
end
|
232
|
-
def to_hash
|
233
|
-
end
|
227
|
+
def to_hash; end
|
234
228
|
end
|
235
229
|
|
236
230
|
# Can only be specified when `entry_type=void`. The reason for the void.
|
@@ -260,8 +254,7 @@ module Orb
|
|
260
254
|
T::Array[Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::VoidReason::TaggedSymbol]
|
261
255
|
)
|
262
256
|
end
|
263
|
-
def self.values
|
264
|
-
end
|
257
|
+
def self.values; end
|
265
258
|
end
|
266
259
|
end
|
267
260
|
end
|