orb-billing 0.1.0.pre.alpha.38 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +10 -2
- data/lib/orb/client.rb +4 -0
- data/lib/orb/internal/transport/base_client.rb +2 -2
- data/lib/orb/internal/transport/pooled_net_requester.rb +15 -6
- data/lib/orb/internal/type/array_of.rb +12 -2
- data/lib/orb/internal/type/base_model.rb +23 -22
- data/lib/orb/internal/type/boolean.rb +5 -1
- data/lib/orb/internal/type/converter.rb +62 -39
- data/lib/orb/internal/type/enum.rb +13 -9
- data/lib/orb/internal/type/hash_of.rb +6 -2
- data/lib/orb/internal/type/io_like.rb +75 -0
- data/lib/orb/internal/type/request_parameters.rb +11 -2
- data/lib/orb/internal/type/union.rb +7 -3
- data/lib/orb/internal/type/unknown.rb +5 -1
- data/lib/orb/internal/util.rb +81 -26
- 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 +8 -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 +8 -14
- data/rbi/lib/orb/internal/type/array_of.rbi +14 -18
- data/rbi/lib/orb/internal/type/base_model.rbi +51 -66
- data/rbi/lib/orb/internal/type/base_page.rbi +5 -10
- data/rbi/lib/orb/internal/type/boolean.rbi +12 -10
- data/rbi/lib/orb/internal/type/converter.rbi +44 -37
- data/rbi/lib/orb/internal/type/enum.rbi +24 -21
- data/rbi/lib/orb/internal/type/hash_of.rbi +13 -18
- data/rbi/lib/orb/internal/type/io_like.rbi +49 -0
- data/rbi/lib/orb/internal/type/request_parameters.rbi +1 -2
- data/rbi/lib/orb/internal/type/union.rbi +19 -21
- data/rbi/lib/orb/internal/type/unknown.rbi +10 -9
- data/rbi/lib/orb/internal/util.rbi +67 -70
- 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/internal/transport/pooled_net_requester.rbs +1 -1
- data/sig/orb/internal/type/array_of.rbs +5 -2
- data/sig/orb/internal/type/base_model.rbs +5 -2
- data/sig/orb/internal/type/boolean.rbs +5 -2
- data/sig/orb/internal/type/converter.rbs +11 -5
- data/sig/orb/internal/type/enum.rbs +5 -2
- data/sig/orb/internal/type/hash_of.rbs +5 -2
- data/sig/orb/internal/type/io_like.rbs +23 -0
- data/sig/orb/internal/type/union.rbs +5 -2
- data/sig/orb/internal/type/unknown.rbs +5 -2
- data/sig/orb/internal/util.rbs +17 -2
- 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 +28 -4
@@ -43,7 +43,7 @@ module Orb
|
|
43
43
|
|
44
44
|
# @!attribute ending_balance
|
45
45
|
# The new value of the customer's balance prior to the transaction, in the
|
46
|
-
#
|
46
|
+
# customer's currency.
|
47
47
|
#
|
48
48
|
# @return [String]
|
49
49
|
required :ending_balance, String
|
@@ -55,7 +55,7 @@ module Orb
|
|
55
55
|
|
56
56
|
# @!attribute starting_balance
|
57
57
|
# The original value of the customer's balance prior to the transaction, in the
|
58
|
-
#
|
58
|
+
# customer's currency.
|
59
59
|
#
|
60
60
|
# @return [String]
|
61
61
|
required :starting_balance, String
|
@@ -11,7 +11,7 @@ module Orb
|
|
11
11
|
|
12
12
|
# @!attribute cursor
|
13
13
|
# Cursor for pagination. This can be populated by the `next_cursor` value returned
|
14
|
-
#
|
14
|
+
# from the initial request.
|
15
15
|
#
|
16
16
|
# @return [String, nil]
|
17
17
|
optional :cursor, String, nil?: true
|
@@ -29,22 +29,22 @@ module Orb
|
|
29
29
|
# @!attribute operation_time_gt
|
30
30
|
#
|
31
31
|
# @return [Time, nil]
|
32
|
-
optional :operation_time_gt, Time,
|
32
|
+
optional :operation_time_gt, Time, nil?: true
|
33
33
|
|
34
34
|
# @!attribute operation_time_gte
|
35
35
|
#
|
36
36
|
# @return [Time, nil]
|
37
|
-
optional :operation_time_gte, Time,
|
37
|
+
optional :operation_time_gte, Time, nil?: true
|
38
38
|
|
39
39
|
# @!attribute operation_time_lt
|
40
40
|
#
|
41
41
|
# @return [Time, nil]
|
42
|
-
optional :operation_time_lt, Time,
|
42
|
+
optional :operation_time_lt, Time, nil?: true
|
43
43
|
|
44
44
|
# @!attribute operation_time_lte
|
45
45
|
#
|
46
46
|
# @return [Time, nil]
|
47
|
-
optional :operation_time_lte, Time,
|
47
|
+
optional :operation_time_lte, Time, nil?: true
|
48
48
|
|
49
49
|
# @!parse
|
50
50
|
# # @param cursor [String, nil]
|
@@ -43,7 +43,7 @@ module Orb
|
|
43
43
|
|
44
44
|
# @!attribute ending_balance
|
45
45
|
# The new value of the customer's balance prior to the transaction, in the
|
46
|
-
#
|
46
|
+
# customer's currency.
|
47
47
|
#
|
48
48
|
# @return [String]
|
49
49
|
required :ending_balance, String
|
@@ -55,7 +55,7 @@ module Orb
|
|
55
55
|
|
56
56
|
# @!attribute starting_balance
|
57
57
|
# The original value of the customer's balance prior to the transaction, in the
|
58
|
-
#
|
58
|
+
# customer's currency.
|
59
59
|
#
|
60
60
|
# @return [String]
|
61
61
|
required :starting_balance, String
|
@@ -29,9 +29,9 @@ module Orb
|
|
29
29
|
|
30
30
|
# @!attribute view_mode
|
31
31
|
# Controls whether Orb returns cumulative costs since the start of the billing
|
32
|
-
#
|
33
|
-
#
|
34
|
-
#
|
32
|
+
# period, or incremental day-by-day costs. If your customer has minimums or
|
33
|
+
# discounts, it's strongly recommended that you use the default cumulative
|
34
|
+
# behavior.
|
35
35
|
#
|
36
36
|
# @return [Symbol, Orb::Models::Customers::CostListByExternalIDParams::ViewMode, nil]
|
37
37
|
optional :view_mode, enum: -> { Orb::Models::Customers::CostListByExternalIDParams::ViewMode }, nil?: true
|
@@ -48,9 +48,9 @@ module Orb
|
|
48
48
|
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
49
49
|
|
50
50
|
# Controls whether Orb returns cumulative costs since the start of the billing
|
51
|
-
#
|
52
|
-
#
|
53
|
-
#
|
51
|
+
# period, or incremental day-by-day costs. If your customer has minimums or
|
52
|
+
# discounts, it's strongly recommended that you use the default cumulative
|
53
|
+
# behavior.
|
54
54
|
module ViewMode
|
55
55
|
extend Orb::Internal::Type::Enum
|
56
56
|
|
@@ -29,9 +29,9 @@ module Orb
|
|
29
29
|
|
30
30
|
# @!attribute view_mode
|
31
31
|
# Controls whether Orb returns cumulative costs since the start of the billing
|
32
|
-
#
|
33
|
-
#
|
34
|
-
#
|
32
|
+
# period, or incremental day-by-day costs. If your customer has minimums or
|
33
|
+
# discounts, it's strongly recommended that you use the default cumulative
|
34
|
+
# behavior.
|
35
35
|
#
|
36
36
|
# @return [Symbol, Orb::Models::Customers::CostListParams::ViewMode, nil]
|
37
37
|
optional :view_mode, enum: -> { Orb::Models::Customers::CostListParams::ViewMode }, nil?: true
|
@@ -48,9 +48,9 @@ module Orb
|
|
48
48
|
# def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
|
49
49
|
|
50
50
|
# Controls whether Orb returns cumulative costs since the start of the billing
|
51
|
-
#
|
52
|
-
#
|
53
|
-
#
|
51
|
+
# period, or incremental day-by-day costs. If your customer has minimums or
|
52
|
+
# discounts, it's strongly recommended that you use the default cumulative
|
53
|
+
# behavior.
|
54
54
|
module ViewMode
|
55
55
|
extend Orb::Internal::Type::Enum
|
56
56
|
|
@@ -17,14 +17,14 @@ module Orb
|
|
17
17
|
|
18
18
|
# @!attribute cursor
|
19
19
|
# Cursor for pagination. This can be populated by the `next_cursor` value returned
|
20
|
-
#
|
20
|
+
# from the initial request.
|
21
21
|
#
|
22
22
|
# @return [String, nil]
|
23
23
|
optional :cursor, String, nil?: true
|
24
24
|
|
25
25
|
# @!attribute [r] include_all_blocks
|
26
26
|
# If set to True, all expired and depleted blocks, as well as active block will be
|
27
|
-
#
|
27
|
+
# returned.
|
28
28
|
#
|
29
29
|
# @return [Boolean, nil]
|
30
30
|
optional :include_all_blocks, Orb::Internal::Type::Boolean
|
@@ -17,14 +17,14 @@ module Orb
|
|
17
17
|
|
18
18
|
# @!attribute cursor
|
19
19
|
# Cursor for pagination. This can be populated by the `next_cursor` value returned
|
20
|
-
#
|
20
|
+
# from the initial request.
|
21
21
|
#
|
22
22
|
# @return [String, nil]
|
23
23
|
optional :cursor, String, nil?: true
|
24
24
|
|
25
25
|
# @!attribute [r] include_all_blocks
|
26
26
|
# If set to True, all expired and depleted blocks, as well as active block will be
|
27
|
-
#
|
27
|
+
# returned.
|
28
28
|
#
|
29
29
|
# @return [Boolean, nil]
|
30
30
|
optional :include_all_blocks, Orb::Internal::Type::Boolean
|
@@ -12,7 +12,7 @@ module Orb
|
|
12
12
|
|
13
13
|
# @!attribute amount
|
14
14
|
# The number of credits to effect. Note that this is required for increment,
|
15
|
-
#
|
15
|
+
# decrement or void operations.
|
16
16
|
#
|
17
17
|
# @return [Float]
|
18
18
|
required :amount, Float
|
@@ -25,22 +25,22 @@ module Orb
|
|
25
25
|
|
26
26
|
# @!attribute currency
|
27
27
|
# The currency or custom pricing unit to use for this ledger entry. If this is a
|
28
|
-
#
|
28
|
+
# real-world currency, it must match the customer's invoicing currency.
|
29
29
|
#
|
30
30
|
# @return [String, nil]
|
31
31
|
optional :currency, String, nil?: true
|
32
32
|
|
33
33
|
# @!attribute description
|
34
34
|
# Optional metadata that can be specified when adding ledger results via the API.
|
35
|
-
#
|
36
|
-
#
|
35
|
+
# For example, this can be used to note an increment refers to trial credits, or
|
36
|
+
# for noting corrections as a result of an incident, etc.
|
37
37
|
#
|
38
38
|
# @return [String, nil]
|
39
39
|
optional :description, String, nil?: true
|
40
40
|
|
41
41
|
# @!attribute effective_date
|
42
42
|
# An ISO 8601 format date that denotes when this credit balance should become
|
43
|
-
#
|
43
|
+
# available for use.
|
44
44
|
#
|
45
45
|
# @return [Time, nil]
|
46
46
|
optional :effective_date, Time, nil?: true
|
@@ -53,9 +53,9 @@ module Orb
|
|
53
53
|
|
54
54
|
# @!attribute invoice_settings
|
55
55
|
# Passing `invoice_settings` automatically generates an invoice for the newly
|
56
|
-
#
|
57
|
-
#
|
58
|
-
#
|
56
|
+
# added credits. If `invoice_settings` is passed, you must specify
|
57
|
+
# per_unit_cost_basis, as the calculation of the invoice total is done on that
|
58
|
+
# basis.
|
59
59
|
#
|
60
60
|
# @return [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::InvoiceSettings, nil]
|
61
61
|
optional :invoice_settings,
|
@@ -64,23 +64,23 @@ module Orb
|
|
64
64
|
|
65
65
|
# @!attribute metadata
|
66
66
|
# User-specified key/value pairs for the resource. Individual keys can be removed
|
67
|
-
#
|
68
|
-
#
|
67
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
68
|
+
# by setting `metadata` to `null`.
|
69
69
|
#
|
70
70
|
# @return [Hash{Symbol=>String, nil}, nil]
|
71
71
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
72
72
|
|
73
73
|
# @!attribute per_unit_cost_basis
|
74
74
|
# Can only be specified when entry_type=increment. How much, in the customer's
|
75
|
-
#
|
75
|
+
# currency, a customer paid for a single credit in this block
|
76
76
|
#
|
77
77
|
# @return [String, nil]
|
78
78
|
optional :per_unit_cost_basis, String, nil?: true
|
79
79
|
|
80
80
|
# @!attribute target_expiry_date
|
81
81
|
# A future date (specified in YYYY-MM-DD format) used for expiration change,
|
82
|
-
#
|
83
|
-
#
|
82
|
+
# denoting when credits transferred (as part of a partial block expiration) should
|
83
|
+
# expire.
|
84
84
|
#
|
85
85
|
# @return [Date]
|
86
86
|
required :target_expiry_date, Date
|
@@ -150,15 +150,15 @@ module Orb
|
|
150
150
|
class InvoiceSettings < Orb::Internal::Type::BaseModel
|
151
151
|
# @!attribute auto_collection
|
152
152
|
# Whether the credits purchase invoice should auto collect with the customer's
|
153
|
-
#
|
153
|
+
# saved payment method.
|
154
154
|
#
|
155
155
|
# @return [Boolean]
|
156
156
|
required :auto_collection, Orb::Internal::Type::Boolean
|
157
157
|
|
158
158
|
# @!attribute net_terms
|
159
159
|
# The net terms determines the difference between the invoice date and the issue
|
160
|
-
#
|
161
|
-
#
|
160
|
+
# date for the invoice. If you intend the invoice to be due on issue, set this
|
161
|
+
# to 0.
|
162
162
|
#
|
163
163
|
# @return [Integer]
|
164
164
|
required :net_terms, Integer
|
@@ -171,7 +171,7 @@ module Orb
|
|
171
171
|
|
172
172
|
# @!attribute [r] require_successful_payment
|
173
173
|
# If true, the new credit block will require that the corresponding invoice is
|
174
|
-
#
|
174
|
+
# paid before it can be drawn down from.
|
175
175
|
#
|
176
176
|
# @return [Boolean, nil]
|
177
177
|
optional :require_successful_payment, Orb::Internal::Type::Boolean
|
@@ -182,9 +182,9 @@ module Orb
|
|
182
182
|
|
183
183
|
# @!parse
|
184
184
|
# # Passing `invoice_settings` automatically generates an invoice for the newly
|
185
|
-
# #
|
186
|
-
# #
|
187
|
-
# #
|
185
|
+
# # added credits. If `invoice_settings` is passed, you must specify
|
186
|
+
# # per_unit_cost_basis, as the calculation of the invoice total is done on that
|
187
|
+
# # basis.
|
188
188
|
# #
|
189
189
|
# # @param auto_collection [Boolean]
|
190
190
|
# # @param net_terms [Integer]
|
@@ -5,7 +5,7 @@ module Orb
|
|
5
5
|
module Customers
|
6
6
|
module Credits
|
7
7
|
# The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid
|
8
|
-
#
|
8
|
+
# credits within Orb.
|
9
9
|
#
|
10
10
|
# @see Orb::Resources::Customers::Credits::Ledger#create_entry_by_external_id
|
11
11
|
module LedgerCreateEntryByExternalIDResponse
|
@@ -95,9 +95,9 @@ module Orb
|
|
95
95
|
|
96
96
|
# @!attribute metadata
|
97
97
|
# User specified key-value pairs for the resource. If not present, this defaults
|
98
|
-
#
|
99
|
-
#
|
100
|
-
#
|
98
|
+
# to an empty dictionary. Individual keys can be removed by setting the value to
|
99
|
+
# `null`, and the entire metadata mapping can be cleared by setting `metadata` to
|
100
|
+
# `null`.
|
101
101
|
#
|
102
102
|
# @return [Hash{Symbol=>String}]
|
103
103
|
required :metadata, Orb::Internal::Type::HashOf[String]
|
@@ -267,9 +267,9 @@ module Orb
|
|
267
267
|
|
268
268
|
# @!attribute metadata
|
269
269
|
# User specified key-value pairs for the resource. If not present, this defaults
|
270
|
-
#
|
271
|
-
#
|
272
|
-
#
|
270
|
+
# to an empty dictionary. Individual keys can be removed by setting the value to
|
271
|
+
# `null`, and the entire metadata mapping can be cleared by setting `metadata` to
|
272
|
+
# `null`.
|
273
273
|
#
|
274
274
|
# @return [Hash{Symbol=>String}]
|
275
275
|
required :metadata, Orb::Internal::Type::HashOf[String]
|
@@ -460,9 +460,9 @@ module Orb
|
|
460
460
|
|
461
461
|
# @!attribute metadata
|
462
462
|
# User specified key-value pairs for the resource. If not present, this defaults
|
463
|
-
#
|
464
|
-
#
|
465
|
-
#
|
463
|
+
# to an empty dictionary. Individual keys can be removed by setting the value to
|
464
|
+
# `null`, and the entire metadata mapping can be cleared by setting `metadata` to
|
465
|
+
# `null`.
|
466
466
|
#
|
467
467
|
# @return [Hash{Symbol=>String}]
|
468
468
|
required :metadata, Orb::Internal::Type::HashOf[String]
|
@@ -639,9 +639,9 @@ module Orb
|
|
639
639
|
|
640
640
|
# @!attribute metadata
|
641
641
|
# User specified key-value pairs for the resource. If not present, this defaults
|
642
|
-
#
|
643
|
-
#
|
644
|
-
#
|
642
|
+
# to an empty dictionary. Individual keys can be removed by setting the value to
|
643
|
+
# `null`, and the entire metadata mapping can be cleared by setting `metadata` to
|
644
|
+
# `null`.
|
645
645
|
#
|
646
646
|
# @return [Hash{Symbol=>String}]
|
647
647
|
required :metadata, Orb::Internal::Type::HashOf[String]
|
@@ -811,9 +811,9 @@ module Orb
|
|
811
811
|
|
812
812
|
# @!attribute metadata
|
813
813
|
# User specified key-value pairs for the resource. If not present, this defaults
|
814
|
-
#
|
815
|
-
#
|
816
|
-
#
|
814
|
+
# to an empty dictionary. Individual keys can be removed by setting the value to
|
815
|
+
# `null`, and the entire metadata mapping can be cleared by setting `metadata` to
|
816
|
+
# `null`.
|
817
817
|
#
|
818
818
|
# @return [Hash{Symbol=>String}]
|
819
819
|
required :metadata, Orb::Internal::Type::HashOf[String]
|
@@ -997,9 +997,9 @@ module Orb
|
|
997
997
|
|
998
998
|
# @!attribute metadata
|
999
999
|
# User specified key-value pairs for the resource. If not present, this defaults
|
1000
|
-
#
|
1001
|
-
#
|
1002
|
-
#
|
1000
|
+
# to an empty dictionary. Individual keys can be removed by setting the value to
|
1001
|
+
# `null`, and the entire metadata mapping can be cleared by setting `metadata` to
|
1002
|
+
# `null`.
|
1003
1003
|
#
|
1004
1004
|
# @return [Hash{Symbol=>String}]
|
1005
1005
|
required :metadata, Orb::Internal::Type::HashOf[String]
|
@@ -1190,9 +1190,9 @@ module Orb
|
|
1190
1190
|
|
1191
1191
|
# @!attribute metadata
|
1192
1192
|
# User specified key-value pairs for the resource. If not present, this defaults
|
1193
|
-
#
|
1194
|
-
#
|
1195
|
-
#
|
1193
|
+
# to an empty dictionary. Individual keys can be removed by setting the value to
|
1194
|
+
# `null`, and the entire metadata mapping can be cleared by setting `metadata` to
|
1195
|
+
# `null`.
|
1196
1196
|
#
|
1197
1197
|
# @return [Hash{Symbol=>String}]
|
1198
1198
|
required :metadata, Orb::Internal::Type::HashOf[String]
|
@@ -12,7 +12,7 @@ module Orb
|
|
12
12
|
|
13
13
|
# @!attribute amount
|
14
14
|
# The number of credits to effect. Note that this is required for increment,
|
15
|
-
#
|
15
|
+
# decrement or void operations.
|
16
16
|
#
|
17
17
|
# @return [Float]
|
18
18
|
required :amount, Float
|
@@ -24,22 +24,22 @@ module Orb
|
|
24
24
|
|
25
25
|
# @!attribute currency
|
26
26
|
# The currency or custom pricing unit to use for this ledger entry. If this is a
|
27
|
-
#
|
27
|
+
# real-world currency, it must match the customer's invoicing currency.
|
28
28
|
#
|
29
29
|
# @return [String, nil]
|
30
30
|
optional :currency, String, nil?: true
|
31
31
|
|
32
32
|
# @!attribute description
|
33
33
|
# Optional metadata that can be specified when adding ledger results via the API.
|
34
|
-
#
|
35
|
-
#
|
34
|
+
# For example, this can be used to note an increment refers to trial credits, or
|
35
|
+
# for noting corrections as a result of an incident, etc.
|
36
36
|
#
|
37
37
|
# @return [String, nil]
|
38
38
|
optional :description, String, nil?: true
|
39
39
|
|
40
40
|
# @!attribute effective_date
|
41
41
|
# An ISO 8601 format date that denotes when this credit balance should become
|
42
|
-
#
|
42
|
+
# available for use.
|
43
43
|
#
|
44
44
|
# @return [Time, nil]
|
45
45
|
optional :effective_date, Time, nil?: true
|
@@ -52,9 +52,9 @@ module Orb
|
|
52
52
|
|
53
53
|
# @!attribute invoice_settings
|
54
54
|
# Passing `invoice_settings` automatically generates an invoice for the newly
|
55
|
-
#
|
56
|
-
#
|
57
|
-
#
|
55
|
+
# added credits. If `invoice_settings` is passed, you must specify
|
56
|
+
# per_unit_cost_basis, as the calculation of the invoice total is done on that
|
57
|
+
# basis.
|
58
58
|
#
|
59
59
|
# @return [Orb::Models::Customers::Credits::LedgerCreateEntryParams::InvoiceSettings, nil]
|
60
60
|
optional :invoice_settings,
|
@@ -63,23 +63,23 @@ module Orb
|
|
63
63
|
|
64
64
|
# @!attribute metadata
|
65
65
|
# User-specified key/value pairs for the resource. Individual keys can be removed
|
66
|
-
#
|
67
|
-
#
|
66
|
+
# by setting the value to `null`, and the entire metadata mapping can be cleared
|
67
|
+
# by setting `metadata` to `null`.
|
68
68
|
#
|
69
69
|
# @return [Hash{Symbol=>String, nil}, nil]
|
70
70
|
optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
|
71
71
|
|
72
72
|
# @!attribute per_unit_cost_basis
|
73
73
|
# Can only be specified when entry_type=increment. How much, in the customer's
|
74
|
-
#
|
74
|
+
# currency, a customer paid for a single credit in this block
|
75
75
|
#
|
76
76
|
# @return [String, nil]
|
77
77
|
optional :per_unit_cost_basis, String, nil?: true
|
78
78
|
|
79
79
|
# @!attribute target_expiry_date
|
80
80
|
# A future date (specified in YYYY-MM-DD format) used for expiration change,
|
81
|
-
#
|
82
|
-
#
|
81
|
+
# denoting when credits transferred (as part of a partial block expiration) should
|
82
|
+
# expire.
|
83
83
|
#
|
84
84
|
# @return [Date]
|
85
85
|
required :target_expiry_date, Date
|
@@ -149,15 +149,15 @@ module Orb
|
|
149
149
|
class InvoiceSettings < Orb::Internal::Type::BaseModel
|
150
150
|
# @!attribute auto_collection
|
151
151
|
# Whether the credits purchase invoice should auto collect with the customer's
|
152
|
-
#
|
152
|
+
# saved payment method.
|
153
153
|
#
|
154
154
|
# @return [Boolean]
|
155
155
|
required :auto_collection, Orb::Internal::Type::Boolean
|
156
156
|
|
157
157
|
# @!attribute net_terms
|
158
158
|
# The net terms determines the difference between the invoice date and the issue
|
159
|
-
#
|
160
|
-
#
|
159
|
+
# date for the invoice. If you intend the invoice to be due on issue, set this
|
160
|
+
# to 0.
|
161
161
|
#
|
162
162
|
# @return [Integer]
|
163
163
|
required :net_terms, Integer
|
@@ -170,7 +170,7 @@ module Orb
|
|
170
170
|
|
171
171
|
# @!attribute [r] require_successful_payment
|
172
172
|
# If true, the new credit block will require that the corresponding invoice is
|
173
|
-
#
|
173
|
+
# paid before it can be drawn down from.
|
174
174
|
#
|
175
175
|
# @return [Boolean, nil]
|
176
176
|
optional :require_successful_payment, Orb::Internal::Type::Boolean
|
@@ -181,9 +181,9 @@ module Orb
|
|
181
181
|
|
182
182
|
# @!parse
|
183
183
|
# # Passing `invoice_settings` automatically generates an invoice for the newly
|
184
|
-
# #
|
185
|
-
# #
|
186
|
-
# #
|
184
|
+
# # added credits. If `invoice_settings` is passed, you must specify
|
185
|
+
# # per_unit_cost_basis, as the calculation of the invoice total is done on that
|
186
|
+
# # basis.
|
187
187
|
# #
|
188
188
|
# # @param auto_collection [Boolean]
|
189
189
|
# # @param net_terms [Integer]
|
@@ -5,7 +5,7 @@ module Orb
|
|
5
5
|
module Customers
|
6
6
|
module Credits
|
7
7
|
# The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid
|
8
|
-
#
|
8
|
+
# credits within Orb.
|
9
9
|
#
|
10
10
|
# @see Orb::Resources::Customers::Credits::Ledger#create_entry
|
11
11
|
module LedgerCreateEntryResponse
|
@@ -94,9 +94,9 @@ module Orb
|
|
94
94
|
|
95
95
|
# @!attribute metadata
|
96
96
|
# User specified key-value pairs for the resource. If not present, this defaults
|
97
|
-
#
|
98
|
-
#
|
99
|
-
#
|
97
|
+
# to an empty dictionary. Individual keys can be removed by setting the value to
|
98
|
+
# `null`, and the entire metadata mapping can be cleared by setting `metadata` to
|
99
|
+
# `null`.
|
100
100
|
#
|
101
101
|
# @return [Hash{Symbol=>String}]
|
102
102
|
required :metadata, Orb::Internal::Type::HashOf[String]
|
@@ -266,9 +266,9 @@ module Orb
|
|
266
266
|
|
267
267
|
# @!attribute metadata
|
268
268
|
# User specified key-value pairs for the resource. If not present, this defaults
|
269
|
-
#
|
270
|
-
#
|
271
|
-
#
|
269
|
+
# to an empty dictionary. Individual keys can be removed by setting the value to
|
270
|
+
# `null`, and the entire metadata mapping can be cleared by setting `metadata` to
|
271
|
+
# `null`.
|
272
272
|
#
|
273
273
|
# @return [Hash{Symbol=>String}]
|
274
274
|
required :metadata, Orb::Internal::Type::HashOf[String]
|
@@ -459,9 +459,9 @@ module Orb
|
|
459
459
|
|
460
460
|
# @!attribute metadata
|
461
461
|
# User specified key-value pairs for the resource. If not present, this defaults
|
462
|
-
#
|
463
|
-
#
|
464
|
-
#
|
462
|
+
# to an empty dictionary. Individual keys can be removed by setting the value to
|
463
|
+
# `null`, and the entire metadata mapping can be cleared by setting `metadata` to
|
464
|
+
# `null`.
|
465
465
|
#
|
466
466
|
# @return [Hash{Symbol=>String}]
|
467
467
|
required :metadata, Orb::Internal::Type::HashOf[String]
|
@@ -638,9 +638,9 @@ module Orb
|
|
638
638
|
|
639
639
|
# @!attribute metadata
|
640
640
|
# User specified key-value pairs for the resource. If not present, this defaults
|
641
|
-
#
|
642
|
-
#
|
643
|
-
#
|
641
|
+
# to an empty dictionary. Individual keys can be removed by setting the value to
|
642
|
+
# `null`, and the entire metadata mapping can be cleared by setting `metadata` to
|
643
|
+
# `null`.
|
644
644
|
#
|
645
645
|
# @return [Hash{Symbol=>String}]
|
646
646
|
required :metadata, Orb::Internal::Type::HashOf[String]
|
@@ -810,9 +810,9 @@ module Orb
|
|
810
810
|
|
811
811
|
# @!attribute metadata
|
812
812
|
# User specified key-value pairs for the resource. If not present, this defaults
|
813
|
-
#
|
814
|
-
#
|
815
|
-
#
|
813
|
+
# to an empty dictionary. Individual keys can be removed by setting the value to
|
814
|
+
# `null`, and the entire metadata mapping can be cleared by setting `metadata` to
|
815
|
+
# `null`.
|
816
816
|
#
|
817
817
|
# @return [Hash{Symbol=>String}]
|
818
818
|
required :metadata, Orb::Internal::Type::HashOf[String]
|
@@ -996,9 +996,9 @@ module Orb
|
|
996
996
|
|
997
997
|
# @!attribute metadata
|
998
998
|
# User specified key-value pairs for the resource. If not present, this defaults
|
999
|
-
#
|
1000
|
-
#
|
1001
|
-
#
|
999
|
+
# to an empty dictionary. Individual keys can be removed by setting the value to
|
1000
|
+
# `null`, and the entire metadata mapping can be cleared by setting `metadata` to
|
1001
|
+
# `null`.
|
1002
1002
|
#
|
1003
1003
|
# @return [Hash{Symbol=>String}]
|
1004
1004
|
required :metadata, Orb::Internal::Type::HashOf[String]
|
@@ -1189,9 +1189,9 @@ module Orb
|
|
1189
1189
|
|
1190
1190
|
# @!attribute metadata
|
1191
1191
|
# User specified key-value pairs for the resource. If not present, this defaults
|
1192
|
-
#
|
1193
|
-
#
|
1194
|
-
#
|
1192
|
+
# to an empty dictionary. Individual keys can be removed by setting the value to
|
1193
|
+
# `null`, and the entire metadata mapping can be cleared by setting `metadata` to
|
1194
|
+
# `null`.
|
1195
1195
|
#
|
1196
1196
|
# @return [Hash{Symbol=>String}]
|
1197
1197
|
required :metadata, Orb::Internal::Type::HashOf[String]
|
@@ -13,22 +13,22 @@ module Orb
|
|
13
13
|
# @!attribute created_at_gt
|
14
14
|
#
|
15
15
|
# @return [Time, nil]
|
16
|
-
optional :created_at_gt, Time,
|
16
|
+
optional :created_at_gt, Time, nil?: true
|
17
17
|
|
18
18
|
# @!attribute created_at_gte
|
19
19
|
#
|
20
20
|
# @return [Time, nil]
|
21
|
-
optional :created_at_gte, Time,
|
21
|
+
optional :created_at_gte, Time, nil?: true
|
22
22
|
|
23
23
|
# @!attribute created_at_lt
|
24
24
|
#
|
25
25
|
# @return [Time, nil]
|
26
|
-
optional :created_at_lt, Time,
|
26
|
+
optional :created_at_lt, Time, nil?: true
|
27
27
|
|
28
28
|
# @!attribute created_at_lte
|
29
29
|
#
|
30
30
|
# @return [Time, nil]
|
31
|
-
optional :created_at_lte, Time,
|
31
|
+
optional :created_at_lte, Time, nil?: true
|
32
32
|
|
33
33
|
# @!attribute currency
|
34
34
|
# The ledger currency or custom pricing unit to use.
|
@@ -38,7 +38,7 @@ module Orb
|
|
38
38
|
|
39
39
|
# @!attribute cursor
|
40
40
|
# Cursor for pagination. This can be populated by the `next_cursor` value returned
|
41
|
-
#
|
41
|
+
# from the initial request.
|
42
42
|
#
|
43
43
|
# @return [String, nil]
|
44
44
|
optional :cursor, String, nil?: true
|