orb-billing 0.3.1 → 0.3.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +14 -0
- data/README.md +3 -3
- data/lib/orb/file_part.rb +2 -2
- data/lib/orb/internal/type/enum.rb +3 -3
- data/lib/orb/internal/type/request_parameters.rb +4 -4
- data/lib/orb/internal/type/union.rb +4 -4
- data/lib/orb/internal/util.rb +1 -1
- data/lib/orb/models/alert.rb +29 -32
- data/lib/orb/models/alert_create_for_customer_params.rb +7 -8
- data/lib/orb/models/alert_create_for_external_customer_params.rb +7 -8
- data/lib/orb/models/alert_create_for_subscription_params.rb +7 -8
- data/lib/orb/models/alert_list_params.rb +0 -1
- data/lib/orb/models/alert_update_params.rb +4 -5
- data/lib/orb/models/amount_discount.rb +6 -7
- data/lib/orb/models/billable_metric.rb +9 -11
- data/lib/orb/models/coupon.rb +9 -12
- data/lib/orb/models/coupon_create_params.rb +6 -8
- data/lib/orb/models/coupon_list_params.rb +0 -2
- data/lib/orb/models/coupons/subscription_list_params.rb +0 -1
- data/lib/orb/models/credit_note.rb +48 -46
- data/lib/orb/models/credit_note_create_params.rb +6 -6
- data/lib/orb/models/credit_note_list_params.rb +0 -1
- data/lib/orb/models/customer.rb +54 -61
- data/lib/orb/models/customer_create_params.rb +41 -53
- data/lib/orb/models/customer_list_params.rb +0 -1
- data/lib/orb/models/customer_update_by_external_id_params.rb +41 -53
- data/lib/orb/models/customer_update_params.rb +41 -51
- data/lib/orb/models/customers/balance_transaction_create_params.rb +3 -3
- data/lib/orb/models/customers/balance_transaction_create_response.rb +0 -2
- data/lib/orb/models/customers/balance_transaction_list_params.rb +0 -1
- data/lib/orb/models/customers/balance_transaction_list_response.rb +0 -2
- data/lib/orb/models/customers/cost_list_by_external_id_params.rb +3 -4
- data/lib/orb/models/customers/cost_list_by_external_id_response.rb +3 -3
- data/lib/orb/models/customers/cost_list_params.rb +3 -4
- data/lib/orb/models/customers/cost_list_response.rb +3 -3
- data/lib/orb/models/customers/credit_list_by_external_id_params.rb +0 -2
- data/lib/orb/models/customers/credit_list_params.rb +0 -2
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +12 -21
- data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +0 -7
- data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +11 -22
- data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +0 -7
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +6 -7
- data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +0 -7
- data/lib/orb/models/customers/credits/ledger_list_params.rb +8 -9
- data/lib/orb/models/customers/credits/ledger_list_response.rb +0 -7
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +10 -15
- data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +0 -6
- data/lib/orb/models/customers/credits/top_up_create_params.rb +7 -15
- data/lib/orb/models/customers/credits/top_up_create_response.rb +0 -6
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +0 -1
- data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +0 -6
- data/lib/orb/models/customers/credits/top_up_list_params.rb +0 -1
- data/lib/orb/models/customers/credits/top_up_list_response.rb +0 -6
- data/lib/orb/models/dimensional_price_group.rb +1 -3
- data/lib/orb/models/dimensional_price_group_create_params.rb +0 -1
- data/lib/orb/models/dimensional_price_group_list_params.rb +0 -1
- data/lib/orb/models/dimensional_price_groups.rb +6 -6
- data/lib/orb/models/discount.rb +5 -5
- data/lib/orb/models/evaluate_price_group.rb +1 -1
- data/lib/orb/models/event_ingest_params.rb +4 -9
- data/lib/orb/models/event_ingest_response.rb +0 -3
- data/lib/orb/models/event_search_params.rb +0 -3
- data/lib/orb/models/event_search_response.rb +0 -4
- data/lib/orb/models/event_update_params.rb +0 -3
- data/lib/orb/models/events/backfill_close_response.rb +0 -4
- data/lib/orb/models/events/backfill_create_params.rb +0 -7
- data/lib/orb/models/events/backfill_create_response.rb +0 -4
- data/lib/orb/models/events/backfill_fetch_response.rb +0 -4
- data/lib/orb/models/events/backfill_list_params.rb +0 -1
- data/lib/orb/models/events/backfill_list_response.rb +0 -4
- data/lib/orb/models/events/backfill_revert_response.rb +0 -4
- data/lib/orb/models/events/event_volumes.rb +3 -3
- data/lib/orb/models/events/volume_list_params.rb +0 -3
- data/lib/orb/models/invoice.rb +157 -202
- data/lib/orb/models/invoice_create_params.rb +14 -21
- data/lib/orb/models/invoice_fetch_upcoming_response.rb +9 -54
- data/lib/orb/models/invoice_issue_params.rb +0 -1
- data/lib/orb/models/invoice_level_discount.rb +4 -4
- data/lib/orb/models/invoice_line_item_create_params.rb +0 -1
- data/lib/orb/models/invoice_line_item_create_response.rb +6 -26
- data/lib/orb/models/invoice_list_params.rb +6 -10
- data/lib/orb/models/invoice_update_params.rb +0 -1
- data/lib/orb/models/item.rb +7 -8
- data/lib/orb/models/item_list_params.rb +0 -1
- data/lib/orb/models/item_update_params.rb +7 -7
- data/lib/orb/models/metric_create_params.rb +0 -1
- data/lib/orb/models/metric_list_params.rb +0 -1
- data/lib/orb/models/metric_update_params.rb +0 -1
- data/lib/orb/models/percentage_discount.rb +6 -8
- data/lib/orb/models/plan.rb +78 -103
- data/lib/orb/models/plan_create_params.rb +727 -800
- data/lib/orb/models/plan_list_params.rb +3 -4
- data/lib/orb/models/plan_update_params.rb +0 -2
- data/lib/orb/models/plans/external_plan_id_update_params.rb +0 -2
- data/lib/orb/models/price.rb +1671 -1724
- data/lib/orb/models/price_create_params.rb +75 -84
- data/lib/orb/models/price_evaluate_params.rb +0 -2
- data/lib/orb/models/price_evaluate_response.rb +3 -3
- data/lib/orb/models/price_list_params.rb +0 -1
- data/lib/orb/models/price_update_params.rb +0 -1
- data/lib/orb/models/prices/external_price_id_update_params.rb +0 -1
- data/lib/orb/models/subscription.rb +86 -122
- data/lib/orb/models/subscription_cancel_params.rb +3 -5
- data/lib/orb/models/subscription_cancel_response.rb +21 -57
- data/lib/orb/models/subscription_change_apply_response.rb +21 -58
- data/lib/orb/models/subscription_change_cancel_response.rb +21 -58
- data/lib/orb/models/subscription_change_retrieve_response.rb +21 -58
- data/lib/orb/models/subscription_create_params.rb +1865 -1815
- data/lib/orb/models/subscription_create_response.rb +21 -57
- data/lib/orb/models/subscription_fetch_costs_params.rb +3 -4
- data/lib/orb/models/subscription_fetch_costs_response.rb +3 -3
- data/lib/orb/models/subscription_fetch_schedule_params.rb +0 -1
- data/lib/orb/models/subscription_fetch_schedule_response.rb +0 -1
- data/lib/orb/models/subscription_fetch_usage_params.rb +6 -8
- data/lib/orb/models/subscription_list_params.rb +3 -4
- data/lib/orb/models/subscription_price_intervals_params.rb +1105 -1017
- data/lib/orb/models/subscription_price_intervals_response.rb +21 -57
- data/lib/orb/models/subscription_schedule_plan_change_params.rb +1906 -1791
- data/lib/orb/models/subscription_schedule_plan_change_response.rb +21 -57
- data/lib/orb/models/subscription_trigger_phase_params.rb +0 -2
- data/lib/orb/models/subscription_trigger_phase_response.rb +21 -57
- data/lib/orb/models/subscription_unschedule_cancellation_response.rb +21 -57
- data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +21 -57
- data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +21 -57
- data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +3 -6
- data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +21 -57
- data/lib/orb/models/subscription_update_params.rb +0 -5
- data/lib/orb/models/subscription_update_trial_params.rb +4 -6
- data/lib/orb/models/subscription_update_trial_response.rb +21 -57
- data/lib/orb/models/subscription_usage.rb +46 -39
- data/lib/orb/models/subscriptions.rb +6 -6
- data/lib/orb/models/trial_discount.rb +6 -7
- data/lib/orb/models/usage_discount.rb +6 -8
- data/lib/orb/resources/alerts.rb +30 -31
- data/lib/orb/resources/coupons/subscriptions.rb +3 -4
- data/lib/orb/resources/coupons.rb +11 -21
- data/lib/orb/resources/credit_notes.rb +10 -11
- data/lib/orb/resources/customers/balance_transactions.rb +3 -4
- data/lib/orb/resources/customers/costs.rb +4 -6
- data/lib/orb/resources/customers/credits/ledger.rb +14 -33
- data/lib/orb/resources/customers/credits/top_ups.rb +10 -20
- data/lib/orb/resources/customers/credits.rb +2 -6
- data/lib/orb/resources/customers.rb +40 -67
- data/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rb +2 -2
- data/lib/orb/resources/dimensional_price_groups.rb +8 -10
- data/lib/orb/resources/events/backfills.rb +2 -10
- data/lib/orb/resources/events/volume.rb +3 -6
- data/lib/orb/resources/events.rb +4 -12
- data/lib/orb/resources/invoice_line_items.rb +1 -2
- data/lib/orb/resources/invoices.rb +26 -43
- data/lib/orb/resources/items.rb +12 -13
- data/lib/orb/resources/metrics.rb +11 -14
- data/lib/orb/resources/plans/external_plan_id.rb +5 -7
- data/lib/orb/resources/plans.rb +14 -23
- data/lib/orb/resources/prices/external_price_id.rb +5 -6
- data/lib/orb/resources/prices.rb +25 -35
- data/lib/orb/resources/subscription_changes.rb +1 -1
- data/lib/orb/resources/subscriptions.rb +49 -107
- data/lib/orb/version.rb +1 -1
- data/lib/orb.rb +1 -0
- data/rbi/orb/client.rbi +5 -4
- data/rbi/orb/errors.rbi +59 -28
- data/rbi/orb/file_part.rbi +9 -6
- data/rbi/orb/internal/page.rbi +19 -6
- data/rbi/orb/internal/transport/base_client.rbi +131 -73
- data/rbi/orb/internal/transport/pooled_net_requester.rbi +25 -12
- data/rbi/orb/internal/type/array_of.rbi +42 -34
- data/rbi/orb/internal/type/base_model.rbi +124 -65
- data/rbi/orb/internal/type/base_page.rbi +11 -7
- data/rbi/orb/internal/type/boolean.rbi +16 -10
- data/rbi/orb/internal/type/converter.rbi +66 -31
- data/rbi/orb/internal/type/enum.rbi +27 -15
- data/rbi/orb/internal/type/file_input.rbi +12 -10
- data/rbi/orb/internal/type/hash_of.rbi +34 -24
- data/rbi/orb/internal/type/request_parameters.rbi +12 -4
- data/rbi/orb/internal/type/union.rbi +60 -25
- data/rbi/orb/internal/type/unknown.rbi +20 -12
- data/rbi/orb/internal/util.rbi +210 -89
- data/rbi/orb/models/alert.rbi +107 -70
- data/rbi/orb/models/alert_create_for_customer_params.rbi +60 -27
- data/rbi/orb/models/alert_create_for_external_customer_params.rbi +68 -29
- data/rbi/orb/models/alert_create_for_subscription_params.rbi +53 -26
- data/rbi/orb/models/alert_disable_params.rbi +17 -6
- data/rbi/orb/models/alert_enable_params.rbi +17 -6
- data/rbi/orb/models/alert_list_params.rbi +23 -20
- data/rbi/orb/models/alert_retrieve_params.rbi +10 -4
- data/rbi/orb/models/alert_update_params.rbi +25 -14
- data/rbi/orb/models/amount_discount.rbi +28 -19
- data/rbi/orb/models/billable_metric.rbi +33 -26
- data/rbi/orb/models/billing_cycle_relative_date.rbi +11 -5
- data/rbi/orb/models/coupon.rbi +28 -20
- data/rbi/orb/models/coupon_archive_params.rbi +10 -4
- data/rbi/orb/models/coupon_create_params.rbi +72 -38
- data/rbi/orb/models/coupon_fetch_params.rbi +10 -4
- data/rbi/orb/models/coupon_list_params.rbi +18 -15
- data/rbi/orb/models/coupons/subscription_list_params.rbi +16 -6
- data/rbi/orb/models/credit_note.rbi +293 -158
- data/rbi/orb/models/credit_note_create_params.rbi +58 -29
- data/rbi/orb/models/credit_note_fetch_params.rbi +10 -4
- data/rbi/orb/models/credit_note_list_params.rbi +20 -17
- data/rbi/orb/models/customer.rbi +430 -329
- data/rbi/orb/models/customer_create_params.rbi +662 -325
- data/rbi/orb/models/customer_delete_params.rbi +10 -4
- data/rbi/orb/models/customer_fetch_by_external_id_params.rbi +10 -4
- data/rbi/orb/models/customer_fetch_params.rbi +10 -4
- data/rbi/orb/models/customer_list_params.rbi +20 -17
- data/rbi/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +10 -4
- data/rbi/orb/models/customer_sync_payment_methods_from_gateway_params.rbi +10 -4
- data/rbi/orb/models/customer_update_by_external_id_params.rbi +1136 -336
- data/rbi/orb/models/customer_update_params.rbi +661 -324
- data/rbi/orb/models/customers/balance_transaction_create_params.rbi +50 -21
- data/rbi/orb/models/customers/balance_transaction_create_response.rbi +154 -61
- data/rbi/orb/models/customers/balance_transaction_list_params.rbi +20 -17
- data/rbi/orb/models/customers/balance_transaction_list_response.rbi +164 -59
- data/rbi/orb/models/customers/cost_list_by_external_id_params.rbi +56 -22
- data/rbi/orb/models/customers/cost_list_by_external_id_response.rbi +162 -124
- data/rbi/orb/models/customers/cost_list_params.rbi +45 -22
- data/rbi/orb/models/customers/cost_list_response.rbi +154 -123
- data/rbi/orb/models/customers/credit_list_by_external_id_params.rbi +18 -15
- data/rbi/orb/models/customers/credit_list_by_external_id_response.rbi +48 -22
- data/rbi/orb/models/customers/credit_list_params.rbi +18 -15
- data/rbi/orb/models/customers/credit_list_response.rbi +44 -21
- data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +106 -68
- data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +643 -434
- data/rbi/orb/models/customers/credits/ledger_create_entry_params.rbi +117 -59
- data/rbi/orb/models/customers/credits/ledger_create_entry_response.rbi +700 -425
- data/rbi/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +102 -44
- data/rbi/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +681 -432
- data/rbi/orb/models/customers/credits/ledger_list_params.rbi +123 -40
- data/rbi/orb/models/customers/credits/ledger_list_response.rbi +735 -389
- data/rbi/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +74 -53
- data/rbi/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +65 -48
- data/rbi/orb/models/customers/credits/top_up_create_params.rbi +84 -45
- data/rbi/orb/models/customers/credits/top_up_create_response.rbi +83 -43
- data/rbi/orb/models/customers/credits/top_up_delete_by_external_id_params.rbi +16 -6
- data/rbi/orb/models/customers/credits/top_up_delete_params.rbi +15 -5
- data/rbi/orb/models/customers/credits/top_up_list_by_external_id_params.rbi +9 -5
- data/rbi/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +70 -49
- data/rbi/orb/models/customers/credits/top_up_list_params.rbi +9 -5
- data/rbi/orb/models/customers/credits/top_up_list_response.rbi +84 -43
- data/rbi/orb/models/dimensional_price_group.rbi +18 -15
- data/rbi/orb/models/dimensional_price_group_create_params.rbi +19 -16
- data/rbi/orb/models/dimensional_price_group_list_params.rbi +16 -6
- data/rbi/orb/models/dimensional_price_group_retrieve_params.rbi +10 -4
- data/rbi/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +10 -9
- data/rbi/orb/models/dimensional_price_groups.rbi +18 -13
- data/rbi/orb/models/discount.rbi +11 -5
- data/rbi/orb/models/evaluate_price_group.rbi +28 -12
- data/rbi/orb/models/event_deprecate_params.rbi +10 -4
- data/rbi/orb/models/event_deprecate_response.rbi +8 -3
- data/rbi/orb/models/event_ingest_params.rbi +37 -31
- data/rbi/orb/models/event_ingest_response.rbi +63 -23
- data/rbi/orb/models/event_search_params.rbi +17 -14
- data/rbi/orb/models/event_search_response.rbi +33 -21
- data/rbi/orb/models/event_update_params.rbi +19 -16
- data/rbi/orb/models/event_update_response.rbi +8 -3
- data/rbi/orb/models/events/backfill_close_params.rbi +10 -9
- data/rbi/orb/models/events/backfill_close_response.rbi +64 -29
- data/rbi/orb/models/events/backfill_create_params.rbi +21 -18
- data/rbi/orb/models/events/backfill_create_response.rbi +63 -29
- data/rbi/orb/models/events/backfill_fetch_params.rbi +10 -9
- data/rbi/orb/models/events/backfill_fetch_response.rbi +64 -29
- data/rbi/orb/models/events/backfill_list_params.rbi +16 -6
- data/rbi/orb/models/events/backfill_list_response.rbi +62 -28
- data/rbi/orb/models/events/backfill_revert_params.rbi +10 -9
- data/rbi/orb/models/events/backfill_revert_response.rbi +63 -29
- data/rbi/orb/models/events/event_volumes.rbi +32 -10
- data/rbi/orb/models/events/volume_list_params.rbi +18 -15
- data/rbi/orb/models/invoice.rbi +1286 -805
- data/rbi/orb/models/invoice_create_params.rbi +97 -69
- data/rbi/orb/models/invoice_fetch_params.rbi +10 -4
- data/rbi/orb/models/invoice_fetch_upcoming_params.rbi +15 -5
- data/rbi/orb/models/invoice_fetch_upcoming_response.rbi +1991 -861
- data/rbi/orb/models/invoice_issue_params.rbi +16 -5
- data/rbi/orb/models/invoice_level_discount.rbi +11 -4
- data/rbi/orb/models/invoice_line_item_create_params.rbi +20 -17
- data/rbi/orb/models/invoice_line_item_create_response.rbi +573 -376
- data/rbi/orb/models/invoice_list_params.rbi +67 -47
- data/rbi/orb/models/invoice_mark_paid_params.rbi +17 -14
- data/rbi/orb/models/invoice_pay_params.rbi +10 -4
- data/rbi/orb/models/invoice_update_params.rbi +15 -10
- data/rbi/orb/models/invoice_void_params.rbi +10 -4
- data/rbi/orb/models/item.rbi +87 -39
- data/rbi/orb/models/item_create_params.rbi +14 -5
- data/rbi/orb/models/item_fetch_params.rbi +10 -4
- data/rbi/orb/models/item_list_params.rbi +16 -6
- data/rbi/orb/models/item_update_params.rbi +79 -39
- data/rbi/orb/models/metric_create_params.rbi +19 -16
- data/rbi/orb/models/metric_fetch_params.rbi +10 -4
- data/rbi/orb/models/metric_list_params.rbi +20 -17
- data/rbi/orb/models/metric_update_params.rbi +15 -10
- data/rbi/orb/models/pagination_metadata.rbi +16 -4
- data/rbi/orb/models/percentage_discount.rbi +32 -19
- data/rbi/orb/models/plan.rbi +496 -365
- data/rbi/orb/models/plan_create_params.rbi +4785 -2875
- data/rbi/orb/models/plan_fetch_params.rbi +10 -4
- data/rbi/orb/models/plan_list_params.rbi +34 -27
- data/rbi/orb/models/plan_update_params.rbi +16 -13
- data/rbi/orb/models/plans/external_plan_id_fetch_params.rbi +10 -9
- data/rbi/orb/models/plans/external_plan_id_update_params.rbi +16 -13
- data/rbi/orb/models/price.rbi +9969 -5024
- data/rbi/orb/models/price_create_params.rbi +501 -245
- data/rbi/orb/models/price_evaluate_params.rbi +20 -17
- data/rbi/orb/models/price_evaluate_response.rbi +11 -6
- data/rbi/orb/models/price_fetch_params.rbi +10 -4
- data/rbi/orb/models/price_list_params.rbi +16 -6
- data/rbi/orb/models/price_update_params.rbi +15 -10
- data/rbi/orb/models/prices/external_price_id_fetch_params.rbi +10 -9
- data/rbi/orb/models/prices/external_price_id_update_params.rbi +15 -10
- data/rbi/orb/models/subscription.rbi +578 -420
- data/rbi/orb/models/subscription_cancel_params.rbi +44 -22
- data/rbi/orb/models/subscription_cancel_response.rbi +700 -438
- data/rbi/orb/models/subscription_change_apply_params.rbi +16 -13
- data/rbi/orb/models/subscription_change_apply_response.rbi +784 -504
- data/rbi/orb/models/subscription_change_cancel_params.rbi +10 -4
- data/rbi/orb/models/subscription_change_cancel_response.rbi +783 -514
- data/rbi/orb/models/subscription_change_retrieve_params.rbi +10 -4
- data/rbi/orb/models/subscription_change_retrieve_response.rbi +782 -524
- data/rbi/orb/models/subscription_create_params.rbi +9021 -6730
- data/rbi/orb/models/subscription_create_response.rbi +700 -438
- data/rbi/orb/models/subscription_fetch_costs_params.rbi +47 -22
- data/rbi/orb/models/subscription_fetch_costs_response.rbi +154 -123
- data/rbi/orb/models/subscription_fetch_params.rbi +10 -4
- data/rbi/orb/models/subscription_fetch_schedule_params.rbi +20 -17
- data/rbi/orb/models/subscription_fetch_schedule_response.rbi +33 -19
- data/rbi/orb/models/subscription_fetch_usage_params.rbi +81 -34
- data/rbi/orb/models/subscription_list_params.rbi +39 -28
- data/rbi/orb/models/subscription_price_intervals_params.rbi +5181 -3822
- data/rbi/orb/models/subscription_price_intervals_response.rbi +720 -453
- data/rbi/orb/models/subscription_schedule_plan_change_params.rbi +8602 -6910
- data/rbi/orb/models/subscription_schedule_plan_change_response.rbi +718 -467
- data/rbi/orb/models/subscription_trigger_phase_params.rbi +16 -13
- data/rbi/orb/models/subscription_trigger_phase_response.rbi +712 -448
- data/rbi/orb/models/subscription_unschedule_cancellation_params.rbi +10 -4
- data/rbi/orb/models/subscription_unschedule_cancellation_response.rbi +719 -467
- data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +16 -5
- data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +693 -502
- data/rbi/orb/models/subscription_unschedule_pending_plan_changes_params.rbi +10 -4
- data/rbi/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +708 -497
- data/rbi/orb/models/subscription_update_fixed_fee_quantity_params.rbi +57 -26
- data/rbi/orb/models/subscription_update_fixed_fee_quantity_response.rbi +719 -467
- data/rbi/orb/models/subscription_update_params.rbi +19 -16
- data/rbi/orb/models/subscription_update_trial_params.rbi +57 -19
- data/rbi/orb/models/subscription_update_trial_response.rbi +712 -447
- data/rbi/orb/models/subscription_usage.rbi +271 -121
- data/rbi/orb/models/subscriptions.rbi +18 -11
- data/rbi/orb/models/top_level_ping_params.rbi +10 -4
- data/rbi/orb/models/top_level_ping_response.rbi +7 -3
- data/rbi/orb/models/trial_discount.rbi +29 -20
- data/rbi/orb/models/usage_discount.rbi +28 -19
- data/rbi/orb/models.rbi +22 -11
- data/rbi/orb/request_options.rbi +12 -6
- data/rbi/orb/resources/alerts.rbi +61 -40
- data/rbi/orb/resources/coupons/subscriptions.rbi +7 -5
- data/rbi/orb/resources/coupons.rbi +33 -18
- data/rbi/orb/resources/credit_notes.rbi +22 -13
- data/rbi/orb/resources/customers/balance_transactions.rbi +17 -9
- data/rbi/orb/resources/customers/costs.rbi +18 -11
- data/rbi/orb/resources/customers/credits/ledger.rbi +98 -74
- data/rbi/orb/resources/customers/credits/top_ups.rbi +61 -25
- data/rbi/orb/resources/customers/credits.rbi +16 -7
- data/rbi/orb/resources/customers.rbi +137 -72
- data/rbi/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi +8 -4
- data/rbi/orb/resources/dimensional_price_groups.rbi +26 -12
- data/rbi/orb/resources/events/backfills.rbi +35 -17
- data/rbi/orb/resources/events/volume.rbi +7 -5
- data/rbi/orb/resources/events.rbi +26 -16
- data/rbi/orb/resources/invoice_line_items.rbi +7 -5
- data/rbi/orb/resources/invoices.rbi +72 -41
- data/rbi/orb/resources/items.rbi +40 -13
- data/rbi/orb/resources/metrics.rbi +25 -15
- data/rbi/orb/resources/plans/external_plan_id.rbi +15 -7
- data/rbi/orb/resources/plans.rbi +57 -47
- data/rbi/orb/resources/prices/external_price_id.rbi +73 -68
- data/rbi/orb/resources/prices.rbi +176 -156
- data/rbi/orb/resources/subscription_changes.rbi +19 -11
- data/rbi/orb/resources/subscriptions.rbi +200 -114
- data/rbi/orb/resources/top_level.rbi +9 -3
- data/sig/orb/internal/page.rbs +0 -2
- data/sig/orb/internal/type/request_parameters.rbs +3 -1
- data/sig/orb/models/alert.rbs +19 -31
- data/sig/orb/models/alert_create_for_customer_params.rbs +3 -7
- data/sig/orb/models/alert_create_for_external_customer_params.rbs +3 -7
- data/sig/orb/models/alert_create_for_subscription_params.rbs +3 -7
- data/sig/orb/models/alert_disable_params.rbs +0 -2
- data/sig/orb/models/alert_enable_params.rbs +0 -2
- data/sig/orb/models/alert_list_params.rbs +0 -2
- data/sig/orb/models/alert_retrieve_params.rbs +0 -2
- data/sig/orb/models/alert_update_params.rbs +3 -7
- data/sig/orb/models/amount_discount.rbs +4 -6
- data/sig/orb/models/billable_metric.rbs +7 -9
- data/sig/orb/models/coupon.rbs +5 -8
- data/sig/orb/models/coupon_archive_params.rbs +0 -2
- data/sig/orb/models/coupon_create_params.rbs +3 -9
- data/sig/orb/models/coupon_fetch_params.rbs +0 -2
- data/sig/orb/models/coupon_list_params.rbs +0 -2
- data/sig/orb/models/coupons/subscription_list_params.rbs +0 -2
- data/sig/orb/models/credit_note.rbs +48 -66
- data/sig/orb/models/credit_note_create_params.rbs +3 -7
- data/sig/orb/models/credit_note_fetch_params.rbs +0 -2
- data/sig/orb/models/credit_note_list_params.rbs +0 -2
- data/sig/orb/models/customer.rbs +43 -63
- data/sig/orb/models/customer_create_params.rbs +32 -52
- data/sig/orb/models/customer_delete_params.rbs +0 -2
- data/sig/orb/models/customer_fetch_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customer_fetch_params.rbs +0 -2
- data/sig/orb/models/customer_list_params.rbs +0 -2
- data/sig/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbs +0 -2
- data/sig/orb/models/customer_sync_payment_methods_from_gateway_params.rbs +0 -2
- data/sig/orb/models/customer_update_by_external_id_params.rbs +32 -52
- data/sig/orb/models/customer_update_params.rbs +32 -52
- data/sig/orb/models/customers/balance_transaction_create_params.rbs +0 -2
- data/sig/orb/models/customers/balance_transaction_create_response.rbs +0 -6
- data/sig/orb/models/customers/balance_transaction_list_params.rbs +0 -2
- data/sig/orb/models/customers/balance_transaction_list_response.rbs +0 -6
- data/sig/orb/models/customers/cost_list_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/cost_list_by_external_id_response.rbs +0 -6
- data/sig/orb/models/customers/cost_list_params.rbs +0 -2
- data/sig/orb/models/customers/cost_list_response.rbs +0 -6
- data/sig/orb/models/customers/credit_list_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/credit_list_by_external_id_response.rbs +0 -2
- data/sig/orb/models/customers/credit_list_params.rbs +0 -2
- data/sig/orb/models/customers/credit_list_response.rbs +0 -2
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbs +3 -7
- data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +1 -43
- data/sig/orb/models/customers/credits/ledger_create_entry_params.rbs +3 -7
- data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +1 -43
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +1 -43
- data/sig/orb/models/customers/credits/ledger_list_params.rbs +0 -2
- data/sig/orb/models/customers/credits/ledger_list_response.rbs +1 -43
- data/sig/orb/models/customers/credits/top_up_create_by_external_id_params.rbs +3 -7
- data/sig/orb/models/customers/credits/top_up_create_by_external_id_response.rbs +0 -4
- data/sig/orb/models/customers/credits/top_up_create_params.rbs +3 -7
- data/sig/orb/models/customers/credits/top_up_create_response.rbs +0 -4
- data/sig/orb/models/customers/credits/top_up_delete_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/credits/top_up_delete_params.rbs +0 -2
- data/sig/orb/models/customers/credits/top_up_list_by_external_id_params.rbs +0 -2
- data/sig/orb/models/customers/credits/top_up_list_by_external_id_response.rbs +0 -4
- data/sig/orb/models/customers/credits/top_up_list_params.rbs +0 -2
- data/sig/orb/models/customers/credits/top_up_list_response.rbs +0 -4
- data/sig/orb/models/dimensional_price_group.rbs +0 -2
- data/sig/orb/models/dimensional_price_group_create_params.rbs +0 -2
- data/sig/orb/models/dimensional_price_group_list_params.rbs +0 -2
- data/sig/orb/models/dimensional_price_group_retrieve_params.rbs +0 -2
- data/sig/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbs +0 -2
- data/sig/orb/models/dimensional_price_groups.rbs +6 -8
- data/sig/orb/models/discount.rbs +5 -5
- data/sig/orb/models/evaluate_price_group.rbs +4 -6
- data/sig/orb/models/event_deprecate_params.rbs +0 -2
- data/sig/orb/models/event_deprecate_response.rbs +0 -2
- data/sig/orb/models/event_ingest_params.rbs +3 -7
- data/sig/orb/models/event_ingest_response.rbs +0 -6
- data/sig/orb/models/event_search_params.rbs +0 -2
- data/sig/orb/models/event_search_response.rbs +0 -4
- data/sig/orb/models/event_update_params.rbs +0 -2
- data/sig/orb/models/event_update_response.rbs +0 -2
- data/sig/orb/models/events/backfill_close_params.rbs +0 -2
- data/sig/orb/models/events/backfill_close_response.rbs +0 -2
- data/sig/orb/models/events/backfill_create_params.rbs +0 -2
- data/sig/orb/models/events/backfill_create_response.rbs +0 -2
- data/sig/orb/models/events/backfill_fetch_params.rbs +0 -2
- data/sig/orb/models/events/backfill_fetch_response.rbs +0 -2
- data/sig/orb/models/events/backfill_list_params.rbs +0 -2
- data/sig/orb/models/events/backfill_list_response.rbs +0 -2
- data/sig/orb/models/events/backfill_revert_params.rbs +0 -2
- data/sig/orb/models/events/backfill_revert_response.rbs +0 -2
- data/sig/orb/models/events/event_volumes.rbs +3 -10
- data/sig/orb/models/events/volume_list_params.rbs +0 -2
- data/sig/orb/models/invoice.rbs +110 -172
- data/sig/orb/models/invoice_create_params.rbs +10 -16
- data/sig/orb/models/invoice_fetch_params.rbs +0 -2
- data/sig/orb/models/invoice_fetch_upcoming_params.rbs +0 -2
- data/sig/orb/models/invoice_fetch_upcoming_response.rbs +2 -64
- data/sig/orb/models/invoice_issue_params.rbs +0 -2
- data/sig/orb/models/invoice_level_discount.rbs +2 -4
- data/sig/orb/models/invoice_line_item_create_params.rbs +0 -2
- data/sig/orb/models/invoice_line_item_create_response.rbs +2 -36
- data/sig/orb/models/invoice_list_params.rbs +4 -6
- data/sig/orb/models/invoice_mark_paid_params.rbs +0 -2
- data/sig/orb/models/invoice_pay_params.rbs +0 -2
- data/sig/orb/models/invoice_update_params.rbs +0 -2
- data/sig/orb/models/invoice_void_params.rbs +0 -2
- data/sig/orb/models/item.rbs +7 -11
- data/sig/orb/models/item_create_params.rbs +0 -2
- data/sig/orb/models/item_fetch_params.rbs +0 -2
- data/sig/orb/models/item_list_params.rbs +0 -2
- data/sig/orb/models/item_update_params.rbs +7 -11
- data/sig/orb/models/metric_create_params.rbs +0 -2
- data/sig/orb/models/metric_fetch_params.rbs +0 -2
- data/sig/orb/models/metric_list_params.rbs +0 -2
- data/sig/orb/models/metric_update_params.rbs +0 -2
- data/sig/orb/models/pagination_metadata.rbs +0 -2
- data/sig/orb/models/percentage_discount.rbs +4 -6
- data/sig/orb/models/plan.rbs +45 -73
- data/sig/orb/models/plan_create_params.rbs +518 -696
- data/sig/orb/models/plan_fetch_params.rbs +0 -2
- data/sig/orb/models/plan_list_params.rbs +0 -2
- data/sig/orb/models/plan_update_params.rbs +0 -2
- data/sig/orb/models/plans/external_plan_id_fetch_params.rbs +0 -2
- data/sig/orb/models/plans/external_plan_id_update_params.rbs +0 -2
- data/sig/orb/models/price.rbs +1194 -1730
- data/sig/orb/models/price_create_params.rbs +59 -97
- data/sig/orb/models/price_evaluate_params.rbs +0 -2
- data/sig/orb/models/price_evaluate_response.rbs +3 -6
- data/sig/orb/models/price_fetch_params.rbs +0 -2
- data/sig/orb/models/price_list_params.rbs +0 -2
- data/sig/orb/models/price_update_params.rbs +0 -2
- data/sig/orb/models/prices/external_price_id_fetch_params.rbs +0 -2
- data/sig/orb/models/prices/external_price_id_update_params.rbs +0 -2
- data/sig/orb/models/subscription.rbs +56 -94
- data/sig/orb/models/subscription_cancel_params.rbs +0 -2
- data/sig/orb/models/subscription_cancel_response.rbs +20 -60
- data/sig/orb/models/subscription_change_apply_params.rbs +0 -2
- data/sig/orb/models/subscription_change_apply_response.rbs +20 -62
- data/sig/orb/models/subscription_change_cancel_params.rbs +0 -2
- data/sig/orb/models/subscription_change_cancel_response.rbs +20 -62
- data/sig/orb/models/subscription_change_retrieve_params.rbs +0 -2
- data/sig/orb/models/subscription_change_retrieve_response.rbs +20 -62
- data/sig/orb/models/subscription_create_params.rbs +1103 -1499
- data/sig/orb/models/subscription_create_response.rbs +20 -60
- data/sig/orb/models/subscription_fetch_costs_params.rbs +0 -2
- data/sig/orb/models/subscription_fetch_costs_response.rbs +0 -6
- data/sig/orb/models/subscription_fetch_params.rbs +0 -2
- data/sig/orb/models/subscription_fetch_schedule_params.rbs +0 -2
- data/sig/orb/models/subscription_fetch_schedule_response.rbs +0 -4
- data/sig/orb/models/subscription_fetch_usage_params.rbs +0 -2
- data/sig/orb/models/subscription_list_params.rbs +0 -2
- data/sig/orb/models/subscription_price_intervals_params.rbs +666 -896
- data/sig/orb/models/subscription_price_intervals_response.rbs +20 -60
- data/sig/orb/models/subscription_schedule_plan_change_params.rbs +1103 -1499
- data/sig/orb/models/subscription_schedule_plan_change_response.rbs +20 -60
- data/sig/orb/models/subscription_trigger_phase_params.rbs +0 -2
- data/sig/orb/models/subscription_trigger_phase_response.rbs +20 -60
- data/sig/orb/models/subscription_unschedule_cancellation_params.rbs +0 -2
- data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +20 -60
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbs +0 -2
- data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +20 -60
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_params.rbs +0 -2
- data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +20 -60
- data/sig/orb/models/subscription_update_fixed_fee_quantity_params.rbs +0 -2
- data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +20 -60
- data/sig/orb/models/subscription_update_params.rbs +0 -2
- data/sig/orb/models/subscription_update_trial_params.rbs +1 -3
- data/sig/orb/models/subscription_update_trial_response.rbs +20 -60
- data/sig/orb/models/subscription_usage.rbs +35 -53
- data/sig/orb/models/subscriptions.rbs +6 -8
- data/sig/orb/models/top_level_ping_params.rbs +0 -2
- data/sig/orb/models/top_level_ping_response.rbs +0 -2
- data/sig/orb/models/trial_discount.rbs +4 -6
- data/sig/orb/models/usage_discount.rbs +4 -6
- data/sig/orb/request_options.rbs +1 -1
- data/sig/orb/resources/alerts.rbs +12 -12
- data/sig/orb/resources/coupons/subscriptions.rbs +1 -1
- data/sig/orb/resources/coupons.rbs +4 -4
- data/sig/orb/resources/credit_notes.rbs +4 -4
- data/sig/orb/resources/customers/credits/ledger.rbs +2 -2
- data/sig/orb/resources/customers/credits/top_ups.rbs +2 -2
- data/sig/orb/resources/customers.rbs +24 -24
- data/sig/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbs +1 -1
- data/sig/orb/resources/dimensional_price_groups.rbs +3 -3
- data/sig/orb/resources/events/volume.rbs +1 -1
- data/sig/orb/resources/events.rbs +1 -1
- data/sig/orb/resources/invoices.rbs +10 -10
- data/sig/orb/resources/items.rbs +5 -5
- data/sig/orb/resources/metrics.rbs +4 -4
- data/sig/orb/resources/plans/external_plan_id.rbs +2 -2
- data/sig/orb/resources/plans.rbs +5 -5
- data/sig/orb/resources/prices.rbs +11 -11
- data/sig/orb/resources/subscriptions.rbs +21 -21
- metadata +2 -2
data/lib/orb/resources/events.rb
CHANGED
@@ -65,15 +65,12 @@ module Orb
|
|
65
65
|
# @param event_name [String] A name to meaningfully identify the action or event type.
|
66
66
|
#
|
67
67
|
# @param properties [Object] A dictionary of custom properties. Values in this dictionary must be numeric, bo
|
68
|
-
# ...
|
69
68
|
#
|
70
69
|
# @param timestamp [Time] An ISO 8601 format date with no timezone offset (i.e. UTC). This should represen
|
71
|
-
# ...
|
72
70
|
#
|
73
71
|
# @param customer_id [String, nil] The Orb Customer identifier
|
74
72
|
#
|
75
73
|
# @param external_customer_id [String, nil] An alias for the Orb customer, whose mapping is specified when creating the cust
|
76
|
-
# ...
|
77
74
|
#
|
78
75
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
79
76
|
#
|
@@ -81,7 +78,7 @@ module Orb
|
|
81
78
|
#
|
82
79
|
# @see Orb::Models::EventUpdateParams
|
83
80
|
def update(event_id, params)
|
84
|
-
parsed, options = Orb::
|
81
|
+
parsed, options = Orb::EventUpdateParams.dump_request(params)
|
85
82
|
@client.request(
|
86
83
|
method: :put,
|
87
84
|
path: ["events/%1$s", event_id],
|
@@ -359,13 +356,11 @@ module Orb
|
|
359
356
|
#
|
360
357
|
# @overload ingest(events:, backfill_id: nil, debug: nil, request_options: {})
|
361
358
|
#
|
362
|
-
# @param events [Array<Orb::
|
359
|
+
# @param events [Array<Orb::EventIngestParams::Event>] Body param:
|
363
360
|
#
|
364
361
|
# @param backfill_id [String, nil] Query param: If this ingestion request is part of a backfill, this parameter tie
|
365
|
-
# ...
|
366
362
|
#
|
367
363
|
# @param debug [Boolean] Query param: Flag to enable additional debug information in the endpoint respons
|
368
|
-
# ...
|
369
364
|
#
|
370
365
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
371
366
|
#
|
@@ -373,7 +368,7 @@ module Orb
|
|
373
368
|
#
|
374
369
|
# @see Orb::Models::EventIngestParams
|
375
370
|
def ingest(params)
|
376
|
-
parsed, options = Orb::
|
371
|
+
parsed, options = Orb::EventIngestParams.dump_request(params)
|
377
372
|
query_params = [:backfill_id, :debug]
|
378
373
|
@client.request(
|
379
374
|
method: :post,
|
@@ -407,13 +402,10 @@ module Orb
|
|
407
402
|
# @overload search(event_ids:, timeframe_end: nil, timeframe_start: nil, request_options: {})
|
408
403
|
#
|
409
404
|
# @param event_ids [Array<String>] This is an explicit array of IDs to filter by. Note that an event's ID is the id
|
410
|
-
# ...
|
411
405
|
#
|
412
406
|
# @param timeframe_end [Time, nil] The end of the timeframe, exclusive, in which to search events. If not specified
|
413
|
-
# ...
|
414
407
|
#
|
415
408
|
# @param timeframe_start [Time, nil] The start of the timeframe, inclusive, in which to search events. If not specifi
|
416
|
-
# ...
|
417
409
|
#
|
418
410
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
419
411
|
#
|
@@ -421,7 +413,7 @@ module Orb
|
|
421
413
|
#
|
422
414
|
# @see Orb::Models::EventSearchParams
|
423
415
|
def search(params)
|
424
|
-
parsed, options = Orb::
|
416
|
+
parsed, options = Orb::EventSearchParams.dump_request(params)
|
425
417
|
@client.request(
|
426
418
|
method: :post,
|
427
419
|
path: "events/search",
|
@@ -18,7 +18,6 @@ module Orb
|
|
18
18
|
# @param invoice_id [String] The id of the Invoice to add this line item.
|
19
19
|
#
|
20
20
|
# @param name [String] The item name associated with this line item. If an item with the same name exis
|
21
|
-
# ...
|
22
21
|
#
|
23
22
|
# @param quantity [Float] The number of units on the line item
|
24
23
|
#
|
@@ -30,7 +29,7 @@ module Orb
|
|
30
29
|
#
|
31
30
|
# @see Orb::Models::InvoiceLineItemCreateParams
|
32
31
|
def create(params)
|
33
|
-
parsed, options = Orb::
|
32
|
+
parsed, options = Orb::InvoiceLineItemCreateParams.dump_request(params)
|
34
33
|
@client.request(
|
35
34
|
method: :post,
|
36
35
|
path: "invoice_line_items",
|
@@ -11,46 +11,33 @@ module Orb
|
|
11
11
|
# @overload create(currency:, invoice_date:, line_items:, net_terms:, customer_id: nil, discount: nil, external_customer_id: nil, memo: nil, metadata: nil, will_auto_issue: nil, request_options: {})
|
12
12
|
#
|
13
13
|
# @param currency [String] An ISO 4217 currency string. Must be the same as the customer's currency if it i
|
14
|
-
# ...
|
15
14
|
#
|
16
15
|
# @param invoice_date [Time] Optional invoice date to set. Must be in the past, if not set, `invoice_date` is
|
17
|
-
# ...
|
18
16
|
#
|
19
|
-
# @param line_items [Array<Orb::
|
17
|
+
# @param line_items [Array<Orb::InvoiceCreateParams::LineItem>]
|
20
18
|
#
|
21
19
|
# @param net_terms [Integer] Determines the difference between the invoice issue date for subscription invoic
|
22
|
-
# ...
|
23
20
|
#
|
24
21
|
# @param customer_id [String, nil] The id of the `Customer` to create this invoice for. One of `customer_id` and `e
|
25
|
-
# ...
|
26
22
|
#
|
27
|
-
# @param discount [Orb::
|
23
|
+
# @param discount [Orb::PercentageDiscount, Orb::TrialDiscount, Orb::UsageDiscount, Orb::AmountDiscount, nil] An optional discount to attach to the invoice.
|
28
24
|
#
|
29
25
|
# @param external_customer_id [String, nil] The `external_customer_id` of the `Customer` to create this invoice for. One of
|
30
|
-
# ...
|
31
26
|
#
|
32
27
|
# @param memo [String, nil] An optional memo to attach to the invoice.
|
33
28
|
#
|
34
29
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
35
|
-
# ...
|
36
30
|
#
|
37
31
|
# @param will_auto_issue [Boolean] When true, this invoice will be submitted for issuance upon creation. When false
|
38
|
-
# ...
|
39
32
|
#
|
40
33
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
41
34
|
#
|
42
|
-
# @return [Orb::
|
35
|
+
# @return [Orb::Invoice]
|
43
36
|
#
|
44
37
|
# @see Orb::Models::InvoiceCreateParams
|
45
38
|
def create(params)
|
46
|
-
parsed, options = Orb::
|
47
|
-
@client.request(
|
48
|
-
method: :post,
|
49
|
-
path: "invoices",
|
50
|
-
body: parsed,
|
51
|
-
model: Orb::Models::Invoice,
|
52
|
-
options: options
|
53
|
-
)
|
39
|
+
parsed, options = Orb::InvoiceCreateParams.dump_request(params)
|
40
|
+
@client.request(method: :post, path: "invoices", body: parsed, model: Orb::Invoice, options: options)
|
54
41
|
end
|
55
42
|
|
56
43
|
# Some parameter documentations has been truncated, see
|
@@ -67,20 +54,19 @@ module Orb
|
|
67
54
|
# @param invoice_id [String]
|
68
55
|
#
|
69
56
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
70
|
-
# ...
|
71
57
|
#
|
72
58
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
73
59
|
#
|
74
|
-
# @return [Orb::
|
60
|
+
# @return [Orb::Invoice]
|
75
61
|
#
|
76
62
|
# @see Orb::Models::InvoiceUpdateParams
|
77
63
|
def update(invoice_id, params = {})
|
78
|
-
parsed, options = Orb::
|
64
|
+
parsed, options = Orb::InvoiceUpdateParams.dump_request(params)
|
79
65
|
@client.request(
|
80
66
|
method: :put,
|
81
67
|
path: ["invoices/%1$s", invoice_id],
|
82
68
|
body: parsed,
|
83
|
-
model: Orb::
|
69
|
+
model: Orb::Invoice,
|
84
70
|
options: options
|
85
71
|
)
|
86
72
|
end
|
@@ -111,16 +97,14 @@ module Orb
|
|
111
97
|
# @param amount_lt [String, nil]
|
112
98
|
#
|
113
99
|
# @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
|
114
|
-
# ...
|
115
100
|
#
|
116
101
|
# @param customer_id [String, nil]
|
117
102
|
#
|
118
|
-
# @param date_type [Symbol, Orb::
|
103
|
+
# @param date_type [Symbol, Orb::InvoiceListParams::DateType, nil]
|
119
104
|
#
|
120
105
|
# @param due_date [Date, nil]
|
121
106
|
#
|
122
107
|
# @param due_date_window [String, nil] Filters invoices by their due dates within a specific time range in the past. Sp
|
123
|
-
# ...
|
124
108
|
#
|
125
109
|
# @param due_date_gt [Date, nil]
|
126
110
|
#
|
@@ -140,17 +124,17 @@ module Orb
|
|
140
124
|
#
|
141
125
|
# @param limit [Integer] The number of items to fetch. Defaults to 20.
|
142
126
|
#
|
143
|
-
# @param status [Array<Symbol, Orb::
|
127
|
+
# @param status [Array<Symbol, Orb::InvoiceListParams::Status>, nil]
|
144
128
|
#
|
145
129
|
# @param subscription_id [String, nil]
|
146
130
|
#
|
147
131
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
148
132
|
#
|
149
|
-
# @return [Orb::Internal::Page<Orb::
|
133
|
+
# @return [Orb::Internal::Page<Orb::Invoice>]
|
150
134
|
#
|
151
135
|
# @see Orb::Models::InvoiceListParams
|
152
136
|
def list(params = {})
|
153
|
-
parsed, options = Orb::
|
137
|
+
parsed, options = Orb::InvoiceListParams.dump_request(params)
|
154
138
|
@client.request(
|
155
139
|
method: :get,
|
156
140
|
path: "invoices",
|
@@ -165,7 +149,7 @@ module Orb
|
|
165
149
|
invoice_date_lte: "invoice_date[lte]"
|
166
150
|
),
|
167
151
|
page: Orb::Internal::Page,
|
168
|
-
model: Orb::
|
152
|
+
model: Orb::Invoice,
|
169
153
|
options: options
|
170
154
|
)
|
171
155
|
end
|
@@ -178,14 +162,14 @@ module Orb
|
|
178
162
|
# @param invoice_id [String]
|
179
163
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
180
164
|
#
|
181
|
-
# @return [Orb::
|
165
|
+
# @return [Orb::Invoice]
|
182
166
|
#
|
183
167
|
# @see Orb::Models::InvoiceFetchParams
|
184
168
|
def fetch(invoice_id, params = {})
|
185
169
|
@client.request(
|
186
170
|
method: :get,
|
187
171
|
path: ["invoices/%1$s", invoice_id],
|
188
|
-
model: Orb::
|
172
|
+
model: Orb::Invoice,
|
189
173
|
options: params[:request_options]
|
190
174
|
)
|
191
175
|
end
|
@@ -203,7 +187,7 @@ module Orb
|
|
203
187
|
#
|
204
188
|
# @see Orb::Models::InvoiceFetchUpcomingParams
|
205
189
|
def fetch_upcoming(params)
|
206
|
-
parsed, options = Orb::
|
190
|
+
parsed, options = Orb::InvoiceFetchUpcomingParams.dump_request(params)
|
207
191
|
@client.request(
|
208
192
|
method: :get,
|
209
193
|
path: "invoices/upcoming",
|
@@ -228,20 +212,19 @@ module Orb
|
|
228
212
|
# @param invoice_id [String]
|
229
213
|
#
|
230
214
|
# @param synchronous [Boolean] If true, the invoice will be issued synchronously. If false, the invoice will be
|
231
|
-
# ...
|
232
215
|
#
|
233
216
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
234
217
|
#
|
235
|
-
# @return [Orb::
|
218
|
+
# @return [Orb::Invoice]
|
236
219
|
#
|
237
220
|
# @see Orb::Models::InvoiceIssueParams
|
238
221
|
def issue(invoice_id, params = {})
|
239
|
-
parsed, options = Orb::
|
222
|
+
parsed, options = Orb::InvoiceIssueParams.dump_request(params)
|
240
223
|
@client.request(
|
241
224
|
method: :post,
|
242
225
|
path: ["invoices/%1$s/issue", invoice_id],
|
243
226
|
body: parsed,
|
244
|
-
model: Orb::
|
227
|
+
model: Orb::Invoice,
|
245
228
|
options: options
|
246
229
|
)
|
247
230
|
end
|
@@ -261,16 +244,16 @@ module Orb
|
|
261
244
|
#
|
262
245
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
263
246
|
#
|
264
|
-
# @return [Orb::
|
247
|
+
# @return [Orb::Invoice]
|
265
248
|
#
|
266
249
|
# @see Orb::Models::InvoiceMarkPaidParams
|
267
250
|
def mark_paid(invoice_id, params)
|
268
|
-
parsed, options = Orb::
|
251
|
+
parsed, options = Orb::InvoiceMarkPaidParams.dump_request(params)
|
269
252
|
@client.request(
|
270
253
|
method: :post,
|
271
254
|
path: ["invoices/%1$s/mark_paid", invoice_id],
|
272
255
|
body: parsed,
|
273
|
-
model: Orb::
|
256
|
+
model: Orb::Invoice,
|
274
257
|
options: options
|
275
258
|
)
|
276
259
|
end
|
@@ -283,14 +266,14 @@ module Orb
|
|
283
266
|
# @param invoice_id [String]
|
284
267
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
285
268
|
#
|
286
|
-
# @return [Orb::
|
269
|
+
# @return [Orb::Invoice]
|
287
270
|
#
|
288
271
|
# @see Orb::Models::InvoicePayParams
|
289
272
|
def pay(invoice_id, params = {})
|
290
273
|
@client.request(
|
291
274
|
method: :post,
|
292
275
|
path: ["invoices/%1$s/pay", invoice_id],
|
293
|
-
model: Orb::
|
276
|
+
model: Orb::Invoice,
|
294
277
|
options: params[:request_options]
|
295
278
|
)
|
296
279
|
end
|
@@ -312,14 +295,14 @@ module Orb
|
|
312
295
|
# @param invoice_id [String]
|
313
296
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
314
297
|
#
|
315
|
-
# @return [Orb::
|
298
|
+
# @return [Orb::Invoice]
|
316
299
|
#
|
317
300
|
# @see Orb::Models::InvoiceVoidParams
|
318
301
|
def void(invoice_id, params = {})
|
319
302
|
@client.request(
|
320
303
|
method: :post,
|
321
304
|
path: ["invoices/%1$s/void", invoice_id],
|
322
|
-
model: Orb::
|
305
|
+
model: Orb::Invoice,
|
323
306
|
options: params[:request_options]
|
324
307
|
)
|
325
308
|
end
|
data/lib/orb/resources/items.rb
CHANGED
@@ -11,12 +11,12 @@ module Orb
|
|
11
11
|
#
|
12
12
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
13
13
|
#
|
14
|
-
# @return [Orb::
|
14
|
+
# @return [Orb::Item]
|
15
15
|
#
|
16
16
|
# @see Orb::Models::ItemCreateParams
|
17
17
|
def create(params)
|
18
|
-
parsed, options = Orb::
|
19
|
-
@client.request(method: :post, path: "items", body: parsed, model: Orb::
|
18
|
+
parsed, options = Orb::ItemCreateParams.dump_request(params)
|
19
|
+
@client.request(method: :post, path: "items", body: parsed, model: Orb::Item, options: options)
|
20
20
|
end
|
21
21
|
|
22
22
|
# This endpoint can be used to update properties on the Item.
|
@@ -24,20 +24,20 @@ module Orb
|
|
24
24
|
# @overload update(item_id, external_connections: nil, name: nil, request_options: {})
|
25
25
|
#
|
26
26
|
# @param item_id [String]
|
27
|
-
# @param external_connections [Array<Orb::
|
27
|
+
# @param external_connections [Array<Orb::ItemUpdateParams::ExternalConnection>, nil]
|
28
28
|
# @param name [String, nil]
|
29
29
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
30
30
|
#
|
31
|
-
# @return [Orb::
|
31
|
+
# @return [Orb::Item]
|
32
32
|
#
|
33
33
|
# @see Orb::Models::ItemUpdateParams
|
34
34
|
def update(item_id, params = {})
|
35
|
-
parsed, options = Orb::
|
35
|
+
parsed, options = Orb::ItemUpdateParams.dump_request(params)
|
36
36
|
@client.request(
|
37
37
|
method: :put,
|
38
38
|
path: ["items/%1$s", item_id],
|
39
39
|
body: parsed,
|
40
|
-
model: Orb::
|
40
|
+
model: Orb::Item,
|
41
41
|
options: options
|
42
42
|
)
|
43
43
|
end
|
@@ -51,23 +51,22 @@ module Orb
|
|
51
51
|
# @overload list(cursor: nil, limit: nil, request_options: {})
|
52
52
|
#
|
53
53
|
# @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
|
54
|
-
# ...
|
55
54
|
#
|
56
55
|
# @param limit [Integer] The number of items to fetch. Defaults to 20.
|
57
56
|
#
|
58
57
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
59
58
|
#
|
60
|
-
# @return [Orb::Internal::Page<Orb::
|
59
|
+
# @return [Orb::Internal::Page<Orb::Item>]
|
61
60
|
#
|
62
61
|
# @see Orb::Models::ItemListParams
|
63
62
|
def list(params = {})
|
64
|
-
parsed, options = Orb::
|
63
|
+
parsed, options = Orb::ItemListParams.dump_request(params)
|
65
64
|
@client.request(
|
66
65
|
method: :get,
|
67
66
|
path: "items",
|
68
67
|
query: parsed,
|
69
68
|
page: Orb::Internal::Page,
|
70
|
-
model: Orb::
|
69
|
+
model: Orb::Item,
|
71
70
|
options: options
|
72
71
|
)
|
73
72
|
end
|
@@ -79,14 +78,14 @@ module Orb
|
|
79
78
|
# @param item_id [String]
|
80
79
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
81
80
|
#
|
82
|
-
# @return [Orb::
|
81
|
+
# @return [Orb::Item]
|
83
82
|
#
|
84
83
|
# @see Orb::Models::ItemFetchParams
|
85
84
|
def fetch(item_id, params = {})
|
86
85
|
@client.request(
|
87
86
|
method: :get,
|
88
87
|
path: ["items/%1$s", item_id],
|
89
|
-
model: Orb::
|
88
|
+
model: Orb::Item,
|
90
89
|
options: params[:request_options]
|
91
90
|
)
|
92
91
|
end
|
@@ -21,20 +21,19 @@ module Orb
|
|
21
21
|
# @param sql [String] A sql string defining the metric.
|
22
22
|
#
|
23
23
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
24
|
-
# ...
|
25
24
|
#
|
26
25
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
27
26
|
#
|
28
|
-
# @return [Orb::
|
27
|
+
# @return [Orb::BillableMetric]
|
29
28
|
#
|
30
29
|
# @see Orb::Models::MetricCreateParams
|
31
30
|
def create(params)
|
32
|
-
parsed, options = Orb::
|
31
|
+
parsed, options = Orb::MetricCreateParams.dump_request(params)
|
33
32
|
@client.request(
|
34
33
|
method: :post,
|
35
34
|
path: "metrics",
|
36
35
|
body: parsed,
|
37
|
-
model: Orb::
|
36
|
+
model: Orb::BillableMetric,
|
38
37
|
options: options
|
39
38
|
)
|
40
39
|
end
|
@@ -51,20 +50,19 @@ module Orb
|
|
51
50
|
# @param metric_id [String]
|
52
51
|
#
|
53
52
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
54
|
-
# ...
|
55
53
|
#
|
56
54
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
57
55
|
#
|
58
|
-
# @return [Orb::
|
56
|
+
# @return [Orb::BillableMetric]
|
59
57
|
#
|
60
58
|
# @see Orb::Models::MetricUpdateParams
|
61
59
|
def update(metric_id, params = {})
|
62
|
-
parsed, options = Orb::
|
60
|
+
parsed, options = Orb::MetricUpdateParams.dump_request(params)
|
63
61
|
@client.request(
|
64
62
|
method: :put,
|
65
63
|
path: ["metrics/%1$s", metric_id],
|
66
64
|
body: parsed,
|
67
|
-
model: Orb::
|
65
|
+
model: Orb::BillableMetric,
|
68
66
|
options: options
|
69
67
|
)
|
70
68
|
end
|
@@ -87,17 +85,16 @@ module Orb
|
|
87
85
|
# @param created_at_lte [Time, nil]
|
88
86
|
#
|
89
87
|
# @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
|
90
|
-
# ...
|
91
88
|
#
|
92
89
|
# @param limit [Integer] The number of items to fetch. Defaults to 20.
|
93
90
|
#
|
94
91
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
95
92
|
#
|
96
|
-
# @return [Orb::Internal::Page<Orb::
|
93
|
+
# @return [Orb::Internal::Page<Orb::BillableMetric>]
|
97
94
|
#
|
98
95
|
# @see Orb::Models::MetricListParams
|
99
96
|
def list(params = {})
|
100
|
-
parsed, options = Orb::
|
97
|
+
parsed, options = Orb::MetricListParams.dump_request(params)
|
101
98
|
@client.request(
|
102
99
|
method: :get,
|
103
100
|
path: "metrics",
|
@@ -108,7 +105,7 @@ module Orb
|
|
108
105
|
created_at_lte: "created_at[lte]"
|
109
106
|
),
|
110
107
|
page: Orb::Internal::Page,
|
111
|
-
model: Orb::
|
108
|
+
model: Orb::BillableMetric,
|
112
109
|
options: options
|
113
110
|
)
|
114
111
|
end
|
@@ -121,14 +118,14 @@ module Orb
|
|
121
118
|
# @param metric_id [String]
|
122
119
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
123
120
|
#
|
124
|
-
# @return [Orb::
|
121
|
+
# @return [Orb::BillableMetric]
|
125
122
|
#
|
126
123
|
# @see Orb::Models::MetricFetchParams
|
127
124
|
def fetch(metric_id, params = {})
|
128
125
|
@client.request(
|
129
126
|
method: :get,
|
130
127
|
path: ["metrics/%1$s", metric_id],
|
131
|
-
model: Orb::
|
128
|
+
model: Orb::BillableMetric,
|
132
129
|
options: params[:request_options]
|
133
130
|
)
|
134
131
|
end
|
@@ -17,23 +17,21 @@ module Orb
|
|
17
17
|
# @param other_external_plan_id [String]
|
18
18
|
#
|
19
19
|
# @param external_plan_id [String, nil] An optional user-defined ID for this plan resource, used throughout the system a
|
20
|
-
# ...
|
21
20
|
#
|
22
21
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
23
|
-
# ...
|
24
22
|
#
|
25
23
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
26
24
|
#
|
27
|
-
# @return [Orb::
|
25
|
+
# @return [Orb::Plan]
|
28
26
|
#
|
29
27
|
# @see Orb::Models::Plans::ExternalPlanIDUpdateParams
|
30
28
|
def update(other_external_plan_id, params = {})
|
31
|
-
parsed, options = Orb::
|
29
|
+
parsed, options = Orb::Plans::ExternalPlanIDUpdateParams.dump_request(params)
|
32
30
|
@client.request(
|
33
31
|
method: :put,
|
34
32
|
path: ["plans/external_plan_id/%1$s", other_external_plan_id],
|
35
33
|
body: parsed,
|
36
|
-
model: Orb::
|
34
|
+
model: Orb::Plan,
|
37
35
|
options: options
|
38
36
|
)
|
39
37
|
end
|
@@ -60,14 +58,14 @@ module Orb
|
|
60
58
|
# @param external_plan_id [String]
|
61
59
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
62
60
|
#
|
63
|
-
# @return [Orb::
|
61
|
+
# @return [Orb::Plan]
|
64
62
|
#
|
65
63
|
# @see Orb::Models::Plans::ExternalPlanIDFetchParams
|
66
64
|
def fetch(external_plan_id, params = {})
|
67
65
|
@client.request(
|
68
66
|
method: :get,
|
69
67
|
path: ["plans/external_plan_id/%1$s", external_plan_id],
|
70
|
-
model: Orb::
|
68
|
+
model: Orb::Plan,
|
71
69
|
options: params[:request_options]
|
72
70
|
)
|
73
71
|
end
|
data/lib/orb/resources/plans.rb
CHANGED
@@ -14,35 +14,29 @@ module Orb
|
|
14
14
|
# @overload create(currency:, name:, prices:, default_invoice_memo: nil, external_plan_id: nil, metadata: nil, net_terms: nil, status: nil, request_options: {})
|
15
15
|
#
|
16
16
|
# @param currency [String] An ISO 4217 currency string for invoices generated by subscriptions on this plan
|
17
|
-
# ...
|
18
17
|
#
|
19
18
|
# @param name [String]
|
20
19
|
#
|
21
|
-
# @param prices [Array<Orb::
|
22
|
-
# ...
|
20
|
+
# @param prices [Array<Orb::PlanCreateParams::Price::Unit, Orb::PlanCreateParams::Price::Package, Orb::PlanCreateParams::Price::Matrix, Orb::PlanCreateParams::Price::Tiered, Orb::PlanCreateParams::Price::TieredBps, Orb::PlanCreateParams::Price::Bps, Orb::PlanCreateParams::Price::BulkBps, Orb::PlanCreateParams::Price::Bulk, Orb::PlanCreateParams::Price::ThresholdTotalAmount, Orb::PlanCreateParams::Price::TieredPackage, Orb::PlanCreateParams::Price::TieredWithMinimum, Orb::PlanCreateParams::Price::UnitWithPercent, Orb::PlanCreateParams::Price::PackageWithAllocation, Orb::PlanCreateParams::Price::TieredWithProration, Orb::PlanCreateParams::Price::UnitWithProration, Orb::PlanCreateParams::Price::GroupedAllocation, Orb::PlanCreateParams::Price::GroupedWithProratedMinimum, Orb::PlanCreateParams::Price::GroupedWithMeteredMinimum, Orb::PlanCreateParams::Price::MatrixWithDisplayName, Orb::PlanCreateParams::Price::BulkWithProration, Orb::PlanCreateParams::Price::GroupedTieredPackage, Orb::PlanCreateParams::Price::MaxGroupTieredPackage, Orb::PlanCreateParams::Price::ScalableMatrixWithUnitPricing, Orb::PlanCreateParams::Price::ScalableMatrixWithTieredPricing, Orb::PlanCreateParams::Price::CumulativeGroupedBulk>] Prices for this plan. If the plan has phases, this includes prices across all ph
|
23
21
|
#
|
24
22
|
# @param default_invoice_memo [String, nil] Free-form text which is available on the invoice PDF and the Orb invoice portal.
|
25
|
-
# ...
|
26
23
|
#
|
27
24
|
# @param external_plan_id [String, nil]
|
28
25
|
#
|
29
26
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
30
|
-
# ...
|
31
27
|
#
|
32
28
|
# @param net_terms [Integer, nil] The net terms determines the difference between the invoice date and the issue d
|
33
|
-
# ...
|
34
29
|
#
|
35
|
-
# @param status [Symbol, Orb::
|
36
|
-
# ...
|
30
|
+
# @param status [Symbol, Orb::PlanCreateParams::Status] The status of the plan to create (either active or draft). If not specified, thi
|
37
31
|
#
|
38
32
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
39
33
|
#
|
40
|
-
# @return [Orb::
|
34
|
+
# @return [Orb::Plan]
|
41
35
|
#
|
42
36
|
# @see Orb::Models::PlanCreateParams
|
43
37
|
def create(params)
|
44
|
-
parsed, options = Orb::
|
45
|
-
@client.request(method: :post, path: "plans", body: parsed, model: Orb::
|
38
|
+
parsed, options = Orb::PlanCreateParams.dump_request(params)
|
39
|
+
@client.request(method: :post, path: "plans", body: parsed, model: Orb::Plan, options: options)
|
46
40
|
end
|
47
41
|
|
48
42
|
# Some parameter documentations has been truncated, see
|
@@ -58,23 +52,21 @@ module Orb
|
|
58
52
|
# @param plan_id [String]
|
59
53
|
#
|
60
54
|
# @param external_plan_id [String, nil] An optional user-defined ID for this plan resource, used throughout the system a
|
61
|
-
# ...
|
62
55
|
#
|
63
56
|
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
64
|
-
# ...
|
65
57
|
#
|
66
58
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
67
59
|
#
|
68
|
-
# @return [Orb::
|
60
|
+
# @return [Orb::Plan]
|
69
61
|
#
|
70
62
|
# @see Orb::Models::PlanUpdateParams
|
71
63
|
def update(plan_id, params = {})
|
72
|
-
parsed, options = Orb::
|
64
|
+
parsed, options = Orb::PlanUpdateParams.dump_request(params)
|
73
65
|
@client.request(
|
74
66
|
method: :put,
|
75
67
|
path: ["plans/%1$s", plan_id],
|
76
68
|
body: parsed,
|
77
|
-
model: Orb::
|
69
|
+
model: Orb::Plan,
|
78
70
|
options: options
|
79
71
|
)
|
80
72
|
end
|
@@ -99,19 +91,18 @@ module Orb
|
|
99
91
|
# @param created_at_lte [Time, nil]
|
100
92
|
#
|
101
93
|
# @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
|
102
|
-
# ...
|
103
94
|
#
|
104
95
|
# @param limit [Integer] The number of items to fetch. Defaults to 20.
|
105
96
|
#
|
106
|
-
# @param status [Symbol, Orb::
|
97
|
+
# @param status [Symbol, Orb::PlanListParams::Status] The plan status to filter to ('active', 'archived', or 'draft').
|
107
98
|
#
|
108
99
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
109
100
|
#
|
110
|
-
# @return [Orb::Internal::Page<Orb::
|
101
|
+
# @return [Orb::Internal::Page<Orb::Plan>]
|
111
102
|
#
|
112
103
|
# @see Orb::Models::PlanListParams
|
113
104
|
def list(params = {})
|
114
|
-
parsed, options = Orb::
|
105
|
+
parsed, options = Orb::PlanListParams.dump_request(params)
|
115
106
|
@client.request(
|
116
107
|
method: :get,
|
117
108
|
path: "plans",
|
@@ -122,7 +113,7 @@ module Orb
|
|
122
113
|
created_at_lte: "created_at[lte]"
|
123
114
|
),
|
124
115
|
page: Orb::Internal::Page,
|
125
|
-
model: Orb::
|
116
|
+
model: Orb::Plan,
|
126
117
|
options: options
|
127
118
|
)
|
128
119
|
end
|
@@ -150,14 +141,14 @@ module Orb
|
|
150
141
|
# @param plan_id [String]
|
151
142
|
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
152
143
|
#
|
153
|
-
# @return [Orb::
|
144
|
+
# @return [Orb::Plan]
|
154
145
|
#
|
155
146
|
# @see Orb::Models::PlanFetchParams
|
156
147
|
def fetch(plan_id, params = {})
|
157
148
|
@client.request(
|
158
149
|
method: :get,
|
159
150
|
path: ["plans/%1$s", plan_id],
|
160
|
-
model: Orb::
|
151
|
+
model: Orb::Plan,
|
161
152
|
options: params[:request_options]
|
162
153
|
)
|
163
154
|
end
|